RubyGems - structured_text_renderer - Versions diffs - 0.0.1 - Mend

structured_text_renderer 0.0.1

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 (141) hide show

data/doc/StructuredTextRenderer/DocumentRenderer.html ADDED Viewed

@@ -0,0 +1,242 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: StructuredTextRenderer::DocumentRenderer
+    &mdash; Documentation by YARD 0.9.16
+</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">
+  pathId = "StructuredTextRenderer::DocumentRenderer";
+  relpath = '../';
+</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 class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (D)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span>
+     &raquo;
+    <span class="title">DocumentRenderer</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: StructuredTextRenderer::DocumentRenderer
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></li>
+            <li class="next">StructuredTextRenderer::DocumentRenderer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/structured_text_renderer/document_renderers/document_renderer.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Document renderer.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#mappings-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#mappings (method)">#mappings</a></span></p>
+    <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="#render-instance_method" title="#render (instance method)">#<strong>render</strong>(document)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Renders all nodes in the document.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">#initialize</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">StructuredTextRenderer::BaseNodeRenderer</a></span></p>
+</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="render-instance_method">
+    #<strong>render</strong>(document)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Renders all nodes in the document.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+7
+8
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/structured_text_renderer/document_renderers/document_renderer.rb', line 7</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_document'>document</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_document'>document</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>content</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_each_with_object'>each_with_object</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_node'>node</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span><span class='op'>|</span>
+    <span class='id identifier rubyid_result'>result</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_find_renderer'>find_renderer</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
+  <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</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='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Wed Sep 26 11:28:08 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.1).
+</div>
+    </div>
+  </body>
+</html>

data/doc/StructuredTextRenderer/EntryBlockRenderer.html ADDED Viewed

@@ -0,0 +1,239 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: StructuredTextRenderer::EntryBlockRenderer
+    &mdash; Documentation by YARD 0.9.16
+</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">
+  pathId = "StructuredTextRenderer::EntryBlockRenderer";
+  relpath = '../';
+</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 class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (E)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span>
+     &raquo;
+    <span class="title">EntryBlockRenderer</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: StructuredTextRenderer::EntryBlockRenderer
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></li>
+            <li class="next">StructuredTextRenderer::EntryBlockRenderer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/structured_text_renderer/block_renderers/entry_block_renderer.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>Default embedded entry renderer. Dumps entry to string. This renderer
+should be overridden for your particular applications.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#mappings-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#mappings (method)">#mappings</a></span></p>
+    <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="#render-instance_method" title="#render (instance method)">#<strong>render</strong>(node)  &#x21d2; Object </a>
+  </span>
+    <span class="summary_desc"><div class='inline'>
+<p>Renders embedded entry node.</p>
+</div></span>
+</li>
+    </ul>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">#initialize</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">StructuredTextRenderer::BaseNodeRenderer</a></span></p>
+</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="render-instance_method">
+    #<strong>render</strong>(node)  &#x21d2; <tt>Object</tt>
+</h3><div class="docstring">
+  <div class="discussion">
+<p>Renders embedded entry node.</p>
+  </div>
+</div>
+<div class="tags">
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+9
+10
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/structured_text_renderer/block_renderers/entry_block_renderer.rb', line 9</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='id identifier rubyid_node'>node</span><span class='rparen'>)</span>
+  <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;div&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_node'>node</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>data</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/div&gt;</span><span class='tstring_end'>&quot;</span></span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+      <div id="footer">
+  Generated on Wed Sep 26 11:28:08 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.1).
+</div>
+    </div>
+  </body>
+</html>

data/doc/StructuredTextRenderer/HeadingFiveRenderer.html ADDED Viewed

@@ -0,0 +1,169 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Class: StructuredTextRenderer::HeadingFiveRenderer
+    &mdash; Documentation by YARD 0.9.16
+</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">
+  pathId = "StructuredTextRenderer::HeadingFiveRenderer";
+  relpath = '../';
+</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 class="nav_wrap">
+      <iframe id="nav" src="../class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="../_index.html">Index (H)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span>
+     &raquo;
+    <span class="title">HeadingFiveRenderer</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Class: StructuredTextRenderer::HeadingFiveRenderer
+</h1>
+<div class="box_info">
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><span class='object_link'><a href="BaseBlockRenderer.html" title="StructuredTextRenderer::BaseBlockRenderer (class)">BaseBlockRenderer</a></span></span>
+        <ul class="fullTree">
+          <li>Object</li>
+            <li class="next"><span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></li>
+            <li class="next"><span class='object_link'><a href="BaseBlockRenderer.html" title="StructuredTextRenderer::BaseBlockRenderer (class)">BaseBlockRenderer</a></span></li>
+            <li class="next">StructuredTextRenderer::HeadingFiveRenderer</li>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+    </dd>
+  </dl>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>lib/structured_text_renderer/block_renderers/heading_five_renderer.rb</dd>
+  </dl>
+</div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+<p>H5 node renderer.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+  <h2>Instance Attribute Summary</h2>
+  <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#mappings-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#mappings (method)">#mappings</a></span></p>
+  <h2>Method Summary</h2>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseBlockRenderer.html" title="StructuredTextRenderer::BaseBlockRenderer (class)">BaseBlockRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseBlockRenderer.html#render-instance_method" title="StructuredTextRenderer::BaseBlockRenderer#render (method)">#render</a></span></p>
+  <h3 class="inherited">Methods inherited from <span class='object_link'><a href="BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></h3>
+  <p class="inherited"><span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">#initialize</a></span></p>
+<div id="constructor_details" class="method_details_list">
+  <h2>Constructor Details</h2>
+    <p class="notice">This class inherits a constructor from <span class='object_link'><a href="BaseNodeRenderer.html#initialize-instance_method" title="StructuredTextRenderer::BaseNodeRenderer#initialize (method)">StructuredTextRenderer::BaseNodeRenderer</a></span></p>
+</div>
+</div>
+      <div id="footer">
+  Generated on Wed Sep 26 11:28:08 2018 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.16 (ruby-2.5.1).
+</div>
+    </div>
+  </body>
+</html>