RubyGems - mbrao - Versions diffs - 1.0.0 - Mend

mbrao 1.0.0

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

data/.gitignore +6 -0
data/.travis-gemfile +13 -0
data/.travis.yml +8 -0
data/.yardopts +1 -0
data/Gemfile +21 -0
data/README.md +60 -0
data/Rakefile +11 -0
data/doc/ActionView/Template/Handlers/MbraoTemplate.html +568 -0
data/doc/ActionView/Template/Handlers.html +125 -0
data/doc/HTML/Pipeline/KramdownFilter.html +354 -0
data/doc/HTML/Pipeline.html +140 -0
data/doc/HTML.html +125 -0
data/doc/Mbrao/Author.html +1402 -0
data/doc/Mbrao/Content.html +4779 -0
data/doc/Mbrao/ContentPublicInterface.html +658 -0
data/doc/Mbrao/Exceptions/InvalidDate.html +133 -0
data/doc/Mbrao/Exceptions/InvalidMetadata.html +133 -0
data/doc/Mbrao/Exceptions/Parsing.html +133 -0
data/doc/Mbrao/Exceptions/Rendering.html +133 -0
data/doc/Mbrao/Exceptions/UnavailableLocalization.html +133 -0
data/doc/Mbrao/Exceptions/Unimplemented.html +133 -0
data/doc/Mbrao/Exceptions/UnknownEngine.html +133 -0
data/doc/Mbrao/Exceptions.html +125 -0
data/doc/Mbrao/Parser.html +418 -0
data/doc/Mbrao/ParsingEngines/Base.html +658 -0
data/doc/Mbrao/ParsingEngines/PlainText.html +571 -0
data/doc/Mbrao/ParsingEngines.html +127 -0
data/doc/Mbrao/PublicInterface/ClassMethods.html +1727 -0
data/doc/Mbrao/PublicInterface.html +134 -0
data/doc/Mbrao/RenderingEngines/Base.html +280 -0
data/doc/Mbrao/RenderingEngines/HtmlPipeline.html +873 -0
data/doc/Mbrao/RenderingEngines.html +127 -0
data/doc/Mbrao/Validations/ClassMethods.html +692 -0
data/doc/Mbrao/Validations.html +134 -0
data/doc/Mbrao/Version.html +189 -0
data/doc/Mbrao.html +130 -0
data/doc/_index.html +395 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +338 -0
data/doc/file.README.html +135 -0
data/doc/file_list.html +55 -0
data/doc/frames.html +28 -0
data/doc/index.html +135 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +516 -0
data/doc/top-level-namespace.html +112 -0
data/lib/mbrao/author.rb +61 -0
data/lib/mbrao/content.rb +300 -0
data/lib/mbrao/exceptions.rb +38 -0
data/lib/mbrao/integrations/rails.rb +51 -0
data/lib/mbrao/parser.rb +276 -0
data/lib/mbrao/parsing_engines/base.rb +51 -0
data/lib/mbrao/parsing_engines/plain_text.rb +187 -0
data/lib/mbrao/rendering_engines/base.rb +22 -0
data/lib/mbrao/rendering_engines/html_pipeline.rb +147 -0
data/lib/mbrao/version.rb +25 -0
data/lib/mbrao.rb +24 -0
data/mbrao.gemspec +31 -0
data/spec/coverage_helper.rb +17 -0
data/spec/mbrao/author_spec.rb +62 -0
data/spec/mbrao/content_spec.rb +280 -0
data/spec/mbrao/integrations/rails_spec.rb +92 -0
data/spec/mbrao/parser_spec.rb +269 -0
data/spec/mbrao/parsing_engines/base_spec.rb +52 -0
data/spec/mbrao/parsing_engines/plain_text_spec.rb +141 -0
data/spec/mbrao/rendering_engines/base_spec.rb +17 -0
data/spec/mbrao/rendering_engines/html_pipeline_spec.rb +128 -0
data/spec/spec_helper.rb +15 -0
metadata +195 -0

data/doc/Mbrao/ContentPublicInterface.html ADDED Viewed

@@ -0,0 +1,658 @@
+<!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>
+  Module: Mbrao::ContentPublicInterface
+    &mdash; Documentation by YARD 0.8.5.2
+</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 (C)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../Mbrao.html" title="Mbrao (module)">Mbrao</a></span></span>
+     &raquo;
+    <span class="title">ContentPublicInterface</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>Module: Mbrao::ContentPublicInterface
+</h1>
+<dl class="box">
+    <dt class="r1">Included in:</dt>
+    <dd class="r1"><span class='object_link'><a href="Content.html" title="Mbrao::Content (class)">Content</a></span></dd>
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">lib/mbrao/content.rb</dd>
+</dl>
+<div class="clear"></div>
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p>Setter methods for the <span class='object_link'><a href="Content.html" title="Mbrao::Content (class)">Content</a></span> class.</p>
+  </div>
+</div>
+<div class="tags">
+</div>
+    <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="#enabled_for_locales%3F-instance_method" title="#enabled_for_locales? (instance method)">- (Boolean) <strong>enabled_for_locales?</strong>(*locales) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Checks if the content is available for at least one of the provided locales.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get_body-instance_method" title="#get_body (instance method)">- (String|HashWithIndifferentAccess) <strong>get_body</strong>(locales = [], engine = :plain_text) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Gets the body returning only the portion which are available for the given locales.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get_more-instance_method" title="#get_more (instance method)">- (String|HashWithIndifferentAccess) <strong>get_more</strong>(locales = []) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Gets the &#8220;more link&#8221; text of the content in the desired locales.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get_tags-instance_method" title="#get_tags (instance method)">- (Array|HashWithIndifferentAccess) <strong>get_tags</strong>(locales = []) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Gets the tags of the content in the desired locales.</p>
+</div></span>
+</li>
+        <li class="public ">
+  <span class="summary_signature">
+      <a href="#get_title-instance_method" title="#get_title (instance method)">- (String|HashWithIndifferentAccess) <strong>get_title</strong>(locales = []) </a>
+  </span>
+    <span class="summary_desc"><div class='inline'><p>Gets the title of the content in the desired locales.</p>
+</div></span>
+</li>
+    </ul>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+      <div class="method_details first">
+  <h3 class="signature first" id="enabled_for_locales?-instance_method">
+    - (<tt>Boolean</tt>) <strong>enabled_for_locales?</strong>(*locales)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Checks if the content is available for at least one of the provided locales.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>locales</span>
+        <span class='type'>(<tt>Array</tt>)</span>
+        &mdash;
+        <div class='inline'><p>The desired locales. Can include <code>*</code> to match all. If none are specified, the default mbrao locale will be used.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Boolean</tt>)</span>
+        &mdash;
+        <div class='inline'><p><code>true</code> if the content is available for at least one of the desired locales, <code>false</code> otherwise.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+14
+15
+16
+17</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mbrao/content.rb', line 14</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_enabled_for_locales?'>enabled_for_locales?</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_locales'>locales</span> <span class='op'>=</span> <span class='const'>Mbrao</span><span class='op'>::</span><span class='const'>Parser</span><span class='period'>.</span><span class='id identifier rubyid_sanitized_array'>sanitized_array</span><span class='lparen'>(</span><span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:strip</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_reject'>reject</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_l'>l</span><span class='op'>|</span> <span class='id identifier rubyid_l'>l</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>*</span><span class='tstring_end'>&quot;</span></span> <span class='rbrace'>}</span>
+  <span class='ivar'>@locales</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>||</span> <span class='id identifier rubyid_locales'>locales</span><span class='period'>.</span><span class='id identifier rubyid_blank?'>blank?</span> <span class='op'>||</span> <span class='lparen'>(</span><span class='ivar'>@locales</span> <span class='op'>&amp;</span> <span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get_body-instance_method">
+    - (<tt>String|HashWithIndifferentAccess</tt>) <strong>get_body</strong>(locales = [], engine = :plain_text)
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Gets the body returning only the portion which are available for the given locales.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>locales</span>
+        <span class='type'>(<tt>String|Array</tt>)</span>
+        <em class="default">(defaults to: <tt>[]</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The desired locales. Can include <code>*</code> to match all. If none are specified, the default mbrao locale will be used.</p>
+</div>
+    </li>
+    <li>
+        <span class='name'>engine</span>
+        <span class='type'>(<tt>String|Symbol|Object</tt>)</span>
+        <em class="default">(defaults to: <tt>:plain_text</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The engine to use to filter contents.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String|HashWithIndifferentAccess</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Return the body of the content in the desired locales. If only one locale is required, then a <code>String</code> is returned, else a <code>HashWithIndifferentAccess</code> with locales as keys.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+32
+33
+34</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mbrao/content.rb', line 32</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get_body'>get_body</span><span class='lparen'>(</span><span class='id identifier rubyid_locales'>locales</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_engine'>engine</span> <span class='op'>=</span> <span class='symbol'>:plain_text</span><span class='rparen'>)</span>
+  <span class='const'>Mbrao</span><span class='op'>::</span><span class='const'>Parser</span><span class='period'>.</span><span class='id identifier rubyid_create_engine'>create_engine</span><span class='lparen'>(</span><span class='id identifier rubyid_engine'>engine</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_filter_content'>filter_content</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get_more-instance_method">
+    - (<tt>String|HashWithIndifferentAccess</tt>) <strong>get_more</strong>(locales = [])
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Gets the &#8220;more link&#8221; text of the content in the desired locales.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>locales</span>
+        <span class='type'>(<tt>String|Array</tt>)</span>
+        <em class="default">(defaults to: <tt>[]</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The desired locales. Can include <code>*</code> to match all. If none are specified, the default mbrao locale will be used.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String|HashWithIndifferentAccess</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Return the label of the “more link” of the content in the desired locales. If only one locale is required, then a <code>String</code> is returned, else a <code>HashWithIndifferentAccess</code> with locales as keys.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+48
+49
+50</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mbrao/content.rb', line 48</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get_more'>get_more</span><span class='lparen'>(</span><span class='id identifier rubyid_locales'>locales</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_filter_attribute_for_locales'>filter_attribute_for_locales</span><span class='lparen'>(</span><span class='ivar'>@more</span><span class='comma'>,</span> <span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get_tags-instance_method">
+    - (<tt>Array|HashWithIndifferentAccess</tt>) <strong>get_tags</strong>(locales = [])
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Gets the tags of the content in the desired locales.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>locales</span>
+        <span class='type'>(<tt>String|Array</tt>)</span>
+        <em class="default">(defaults to: <tt>[]</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The desired locales. Can include <code>*</code> to match all. If none are specified, the default mbrao locale will be used.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>Array|HashWithIndifferentAccess</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Return the title of the content in the desired locales. If only one locale is required, then a <code>Array</code> is returned, else a <code>HashWithIndifferentAccess</code> with locales as keys.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+40
+41
+42</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mbrao/content.rb', line 40</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get_tags'>get_tags</span><span class='lparen'>(</span><span class='id identifier rubyid_locales'>locales</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_filter_attribute_for_locales'>filter_attribute_for_locales</span><span class='lparen'>(</span><span class='ivar'>@tags</span><span class='comma'>,</span> <span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+      <div class="method_details ">
+  <h3 class="signature " id="get_title-instance_method">
+    - (<tt>String|HashWithIndifferentAccess</tt>) <strong>get_title</strong>(locales = [])
+</h3><div class="docstring">
+  <div class="discussion">
+    <p>Gets the title of the content in the desired locales.</p>
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+    <li>
+        <span class='name'>locales</span>
+        <span class='type'>(<tt>String|Array</tt>)</span>
+        <em class="default">(defaults to: <tt>[]</tt>)</em>
+        &mdash;
+        <div class='inline'><p>The desired locales. Can include <code>*</code> to match all. If none are specified, the default mbrao locale will be used.</p>
+</div>
+    </li>
+</ul>
+<p class="tag_title">Returns:</p>
+<ul class="return">
+    <li>
+        <span class='type'>(<tt>String|HashWithIndifferentAccess</tt>)</span>
+        &mdash;
+        <div class='inline'><p>Return the title of the content in the desired locales. If only one locale is required, then a <code>String</code> is returned, else a <code>HashWithIndifferentAccess</code> with locales as keys.</p>
+</div>
+    </li>
+</ul>
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/mbrao/content.rb', line 23</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_get_title'>get_title</span><span class='lparen'>(</span><span class='id identifier rubyid_locales'>locales</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_filter_attribute_for_locales'>filter_attribute_for_locales</span><span class='lparen'>(</span><span class='ivar'>@title</span><span class='comma'>,</span> <span class='id identifier rubyid_locales'>locales</span><span class='rparen'>)</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>
+    <div id="footer">
+  Generated on Fri Mar  1 09:13:30 2013 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.5.2 (ruby-1.9.3).
+</div>
+  </body>
+</html>