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/file.README.html ADDED Viewed

@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+    &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 = "README";
+  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="file_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</a> &raquo;
+    <span class="title">File: README</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"><div id='filecontents'>
+<h1 id="label-Contentful+Structured+Text+Renderer">Contentful Structured Text Renderer</h1>
+<p><a href="https://www.contentful.com">Contentful</a> provides a content
+infrastructure for digital teams to power content in websites, apps, and
+devices. Unlike a CMS, Contentful was built to integrate with the modern
+software stack. It offers a central hub for structured content, powerful
+management and delivery APIs, and a customizable web app that enable
+developers and content creators to ship digital products faster.</p>
+<p>This library provides rendering capabilities for the
+<code>StructuredText</code> field type. It is recommended to be used
+alongside the <a
+href="https://www.github.com/contentful/contentful.rb">Contentful Delivery
+SDK</a>. By default this library will serialize <code>StructuredText</code>
+fields into it&#39;s corresponding HTML representation. All behaviour can
+be overridden to serialize to different formats.</p>
+<h2 id="label-Installation">Installation</h2>
+<p>Install Contentful Structured Text Renderer from RubyGems:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_structured_text_renderer'>structured_text_renderer</span>
+</code></pre>
+<h2 id="label-Usage">Usage</h2>
+<p>Create a renderer:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>structured_text_renderer</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span>
+</code></pre>
+<p>Render your document:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_renderer'>renderer</span><span class='period'>.</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>
+</code></pre>
+<h2 id="label-Using+different+renderers">Using different renderers</h2>
+<p>There are many cases in which HTML serialization is not what you want.
+Therefore, all renderers are overridable when creating a
+<code>StructuredTextRenderer</code>.</p>
+<p>Also, if you&#39;re planning to embed entries within your structured text,
+overriding the <code>&#39;embedded-entry-block&#39;</code> mapping is a
+must, as by default it only does
+<code>&lt;div&gt;#{entry.to_s}&lt;/div&gt;</code>.</p>
+<p>You can override the configuration like follows:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>embedded-entry-block</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>MyEntryBlockRenderer</span>
+<span class='rparen'>)</span>
+</code></pre>
+<p>Where <code>MyEntryBlockRenderer</code> requires to have a
+<code>#render(node)</code> method and needs to return a string.</p>
+<p>An example entry renderer, assuming our entry has 2 fields called
+<code>name</code> and <code>description</code> could be:</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyEntryBlockRenderer</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></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='id identifier rubyid_entry'>entry</span> <span class='op'>=</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;div class=&#39;my-entry&#39;&gt;&lt;h3&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/h3&gt;&lt;p&gt;&lt;small&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/p&gt;&lt;/small&gt;&lt;/div&gt;</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+</code></pre>
+<h2 id="label-Dealing+with+unknown+node+types">Dealing with unknown node types</h2>
+<p>By default, this gem will treat all unknown node types as errors and will
+raise an exception letting the user know which node mapping is missing. If
+you wish to remove this behaviour then replace the <code>nil</code> key of
+the mapping with a NullRenderer that returns an empty string, or something
+similar.</p>
+<p>An example would be like follows:</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>SilentNullRenderer</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></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_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='kw'>nil</span> <span class='op'>=&gt;</span> <span class='const'>SilentNullRenderer</span>
+<span class='rparen'>)</span>
+</code></pre>
+<h2 id="label-License">License</h2>
+<p>Copyright © 2018 Contentful GmbH. See <a href="./LICENSE">LICENSE</a> for
+further details.</p>
+<h2 id="label-Contributing">Contributing</h2>
+<p>Feel free to improve this tool by submitting a Pull Request.</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>

data/doc/file_list.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.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" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <title>File List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <div id="content">
+      <div class="fixed_header">
+        <h1 id="full_list_header">File List</h1>
+        <div id="full_list_nav">
+            <span><a target="_self" href="class_list.html">
+              Classes
+            </a></span>
+            <span><a target="_self" href="method_list.html">
+              Methods
+            </a></span>
+            <span><a target="_self" href="file_list.html">
+              Files
+            </a></span>
+        </div>
+        <div id="search">Search: <input type="text" /></div>
+      </div>
+      <ul id="full_list" class="file">
+  <li id="object_README" class="odd">
+    <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
+  </li>
+  <li id="object_CHANGELOG" class="even">
+    <div class="item"><span class="object_link"><a href="file.CHANGELOG.html" title="CHANGELOG">CHANGELOG</a></span></div>
+  </li>
+  <li id="object_LICENSE" class="odd">
+    <div class="item"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></span></div>
+  </li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/frames.html ADDED Viewed

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+	<title>Documentation by YARD 0.9.16</title>
+</head>
+<script type="text/javascript" charset="utf-8">
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : 'index.html';
+  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+  window.top.location = name;
+</script>
+<noscript>
+  <h1>Oops!</h1>
+  <h2>YARD requires JavaScript!</h2>
+</noscript>
+</html>

data/doc/index.html ADDED Viewed

@@ -0,0 +1,171 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+    &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 = "README";
+  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</a> &raquo;
+    <span class="title">File: README</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"><div id='filecontents'>
+<h1 id="label-Contentful+Structured+Text+Renderer">Contentful Structured Text Renderer</h1>
+<p><a href="https://www.contentful.com">Contentful</a> provides a content
+infrastructure for digital teams to power content in websites, apps, and
+devices. Unlike a CMS, Contentful was built to integrate with the modern
+software stack. It offers a central hub for structured content, powerful
+management and delivery APIs, and a customizable web app that enable
+developers and content creators to ship digital products faster.</p>
+<p>This library provides rendering capabilities for the
+<code>StructuredText</code> field type. It is recommended to be used
+alongside the <a
+href="https://www.github.com/contentful/contentful.rb">Contentful Delivery
+SDK</a>. By default this library will serialize <code>StructuredText</code>
+fields into it&#39;s corresponding HTML representation. All behaviour can
+be overridden to serialize to different formats.</p>
+<h2 id="label-Installation">Installation</h2>
+<p>Install Contentful Structured Text Renderer from RubyGems:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_structured_text_renderer'>structured_text_renderer</span>
+</code></pre>
+<h2 id="label-Usage">Usage</h2>
+<p>Create a renderer:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>structured_text_renderer</span><span class='tstring_end'>&#39;</span></span>
+<span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span>
+</code></pre>
+<p>Render your document:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_renderer'>renderer</span><span class='period'>.</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>
+</code></pre>
+<h2 id="label-Using+different+renderers">Using different renderers</h2>
+<p>There are many cases in which HTML serialization is not what you want.
+Therefore, all renderers are overridable when creating a
+<code>StructuredTextRenderer</code>.</p>
+<p>Also, if you&#39;re planning to embed entries within your structured text,
+overriding the <code>&#39;embedded-entry-block&#39;</code> mapping is a
+must, as by default it only does
+<code>&lt;div&gt;#{entry.to_s}&lt;/div&gt;</code>.</p>
+<p>You can override the configuration like follows:</p>
+<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>embedded-entry-block</span><span class='tstring_end'>&#39;</span></span> <span class='op'>=&gt;</span> <span class='const'>MyEntryBlockRenderer</span>
+<span class='rparen'>)</span>
+</code></pre>
+<p>Where <code>MyEntryBlockRenderer</code> requires to have a
+<code>#render(node)</code> method and needs to return a string.</p>
+<p>An example entry renderer, assuming our entry has 2 fields called
+<code>name</code> and <code>description</code> could be:</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>MyEntryBlockRenderer</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></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='id identifier rubyid_entry'>entry</span> <span class='op'>=</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='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;div class=&#39;my-entry&#39;&gt;&lt;h3&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/h3&gt;&lt;p&gt;&lt;small&gt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_description'>description</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;/p&gt;&lt;/small&gt;&lt;/div&gt;</span><span class='tstring_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+</code></pre>
+<h2 id="label-Dealing+with+unknown+node+types">Dealing with unknown node types</h2>
+<p>By default, this gem will treat all unknown node types as errors and will
+raise an exception letting the user know which node mapping is missing. If
+you wish to remove this behaviour then replace the <code>nil</code> key of
+the mapping with a NullRenderer that returns an empty string, or something
+similar.</p>
+<p>An example would be like follows:</p>
+<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>SilentNullRenderer</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/BaseNodeRenderer.html" title="StructuredTextRenderer::BaseNodeRenderer (class)">BaseNodeRenderer</a></span></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_end'>&quot;</span></span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span>
+<span class='id identifier rubyid_renderer'>renderer</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="StructuredTextRenderer.html" title="StructuredTextRenderer (module)">StructuredTextRenderer</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html" title="StructuredTextRenderer::Renderer (class)">Renderer</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="StructuredTextRenderer/Renderer.html#initialize-instance_method" title="StructuredTextRenderer::Renderer#initialize (method)">new</a></span></span><span class='lparen'>(</span>
+  <span class='kw'>nil</span> <span class='op'>=&gt;</span> <span class='const'>SilentNullRenderer</span>
+<span class='rparen'>)</span>
+</code></pre>
+<h2 id="label-License">License</h2>
+<p>Copyright © 2018 Contentful GmbH. See <a href="./LICENSE">LICENSE</a> for
+further details.</p>
+<h2 id="label-Contributing">Contributing</h2>
+<p>Feel free to improve this tool by submitting a Pull Request.</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>