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

@@ -0,0 +1,135 @@
+<!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=US-ASCII" />
+<title>
+  File: README
+    &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</a> &raquo;
+    <span class="title">File: README</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"><div id='filecontents'><h1 id="introduction">Introduction</h1>
+<p><a href="http://badge.fury.io/rb/mbrao"><img src="https://badge.fury.io/rb/mbrao.png" alt="Gem Version" /></a>
+<a href="https://gemnasium.com/ShogunPanda/mbrao"><img src="https://gemnasium.com/ShogunPanda/mbrao.png?travis" alt="Dependency Status" /></a>
+<a href="https://travis-ci.org/ShogunPanda/mbrao"><img src="https://secure.travis-ci.org/ShogunPanda/mbrao.png?branch=master" alt="Build Status" /></a>
+<a href="https://codeclimate.com/github/ShogunPanda/mbrao"><img src="https://codeclimate.com/github/ShogunPanda/mbrao.png" alt="Code Climate" /></a></p>
+<p>A content parser and renderer with embedded metadata support.</p>
+<p>http://sw.cow.tc/mbrao</p>
+<p>http://rdoc.info/gems/mbrao</p>
+<h1 id="introduction-1">Introduction</h1>
+<p>mbrao is a content parser and renderer framework for managing posts which have both metadata and content.</p>
+<p>First of all a big thanks to the <a href="https://github.com/steveklabnik/metadown">metadown</a> project which gave me the final idea.</p>
+<h2 id="usage">Usage</h2>
+<p>Using mbrao is pretty simple. First of all you have to parse a file with a parsing engine:</p>
+<p><code>content = Mbrao::Parser.parse(File.read("/your/content.txt")</code></p>
+<p>The default is a plain text reader. This engine reads a text file and parse metadata embedded between <code>{{metadata}}</code> and <code>{{/metadata}}</code> tag in YAML format.</p>
+<p>The method above will return a <code>Content</code> object which you can use in your code. This object has builtin support for title, body and tags metadata; all with locale support.</p>
+<p>There is also locale filtering. See documentation for more information.</p>
+<p>At the end, you can render the content using any engine of your choice:</p>
+<p><code>Mbrao::Parser.render(content)</code></p>
+<p>The default is a <a href="https://github.com/jch/html-pipeline">html-pipeline</a> renderer with <a href="http://kramdown.rubyforge.org/">kramdown</a> support.</p>
+<h2 id="ruby-on-rails-support">Ruby on Rails support</h2>
+<p>mbrao has support for integrations with other frameworks. Builtin there is support for Ruby on Rails integration.</p>
+<p>By including <code>gem mbrao</code> in your <code>Gemfile</code> you&#8217;ll get automatic rendering of <code>emt</code> file.</p>
+<p>You can customize the rendering engine used by including the <code>engine</code> metadata. Also, your controller will get a new <code>mbrao_content</code> helper method with the parsed content.</p>
+<h2 id="contributing-to-mbrao">Contributing to mbrao</h2>
+<ul>
+  <li>Check out the latest master to make sure the feature hasn&#8217;t been implemented or the bug hasn&#8217;t been fixed yet.</li>
+  <li>Check out the issue tracker to make sure someone already hasn&#8217;t requested it and/or contributed it.</li>
+  <li>Fork the project.</li>
+  <li>Start a feature/bugfix branch.</li>
+  <li>Commit and push until you are happy with your contribution.</li>
+  <li>Make sure to add tests for it. This is important so I don&#8217;t break it in a future version unintentionally.</li>
+  <li>Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.</li>
+</ul>
+<h2 id="copyright">Copyright</h2>
+<p>Copyright (C) 2013 and above Shogun (shogun_panda@me.com).</p>
+<p>Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.</p>
+</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>

data/doc/js/app.js ADDED Viewed

@@ -0,0 +1,214 @@
+function createSourceLinks() {
+    $('.method_details_list .source_code').
+        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+    $('.toggleSource').toggle(function() {
+       $(this).parent().nextAll('.source_code').slideDown(100);
+       $(this).text("Hide source");
+    },
+    function() {
+        $(this).parent().nextAll('.source_code').slideUp(100);
+        $(this).text("View source");
+    });
+}
+function createDefineLinks() {
+    var tHeight = 0;
+    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+    $('.toggleDefines').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().show();
+        $(this).parent().prev().height($(this).parent().height());
+        $(this).text("(less)");
+    },
+    function() {
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("more...");
+    });
+}
+function createFullTreeLinks() {
+    var tHeight = 0;
+    $('.inheritanceTree').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).parent().toggleClass('showAll');
+        $(this).text("(hide)");
+        $(this).parent().prev().height($(this).parent().height());
+    },
+    function() {
+        $(this).parent().toggleClass('showAll');
+        $(this).parent().prev().height(tHeight);
+        $(this).text("show all");
+    });
+}
+function fixBoxInfoHeights() {
+    $('dl.box dd.r1, dl.box dd.r2').each(function() {
+       $(this).prev().height($(this).height());
+    });
+}
+function searchFrameLinks() {
+  $('.full_list_link').click(function() {
+    toggleSearchFrame(this, $(this).attr('href'));
+    return false;
+  });
+}
+function toggleSearchFrame(id, link) {
+  var frame = $('#search_frame');
+  $('#search a').removeClass('active').addClass('inactive');
+  if (frame.attr('src') == link && frame.css('display') != "none") {
+    frame.slideUp(100);
+    $('#search a').removeClass('active inactive');
+  }
+  else {
+    $(id).addClass('active').removeClass('inactive');
+    frame.attr('src', link).slideDown(100);
+  }
+}
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+function framesInit() {
+  if (hasFrames) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+    window.top.document.title = $('html head title').text();
+  }
+  else {
+    $('#menu .noframes a').text('frames').attr('href', framesUrl);
+  }
+}
+function keyboardShortcuts() {
+  if (window.top.frames.main) return;
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    if (typeof evt.target !== "undefined" &&
+        (evt.target.nodeName == "INPUT" ||
+        evt.target.nodeName == "TEXTAREA")) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
+    }
+  });
+}
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    if (localStorage) {
+      localStorage.summaryCollapsed = $(this).text();
+    }
+    $('.summary_toggle').each(function() {
+      $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+      var next = $(this).parent().parent().nextAll('ul.summary').first();
+      if (next.hasClass('compact')) {
+        next.toggle();
+        next.nextAll('ul.summary').first().toggle();
+      }
+      else if (next.hasClass('summary')) {
+        var list = $('<ul class="summary compact" />');
+        list.html(next.html());
+        list.find('.summary_desc, .note').remove();
+        list.find('a').each(function() {
+          $(this).html($(this).find('strong').html());
+          $(this).parent().html($(this)[0].outerHTML);
+        });
+        next.before(list);
+        next.toggle();
+      }
+    });
+    return false;
+  });
+  if (localStorage) {
+    if (localStorage.summaryCollapsed == "collapse") {
+      $('.summary_toggle').first().click();
+    }
+    else localStorage.summaryCollapsed = "expand";
+  }
+}
+function fixOutsideWorldLinks() {
+  $('a').each(function() {
+    if (window.location.host != this.host) this.target = '_parent';
+  });
+}
+function generateTOC() {
+  if ($('#filecontents').length === 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
+  if ($('#filecontents h1').length > 1) tags.unshift('h1');
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
+  $(tags.join(', ')).each(function() {
+    if ($(this).parents('.method_details .docstring').length != 0) return;
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
+      var proposedId = $(this).attr('toc-id');
+      if (typeof(proposedId) != "undefined") this.id = proposedId;
+      else {
+        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+        this.id = proposedId;
+      }
+    }
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    var title = $(this).attr('toc-title');
+    if (typeof(title) == "undefined") title = $(this).text();
+    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  $('#content').prepend(html);
+  $('#toc').append(_toc);
+  $('#toc .hide_toc').toggle(function() {
+    $('#toc .top').slideUp('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  }, function() {
+    $('#toc .top').slideDown('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  });
+  $('#toc .float_toc').toggle(function() {
+    $(this).text('float');
+    $('#toc').toggleClass('nofloat');
+  }, function() {
+    $(this).text('left');
+    $('#toc').toggleClass('nofloat');
+  });
+}
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
+$(fixOutsideWorldLinks);
+$(generateTOC);

data/doc/js/full_list.js ADDED Viewed

@@ -0,0 +1,173 @@
+var inSearch = null;
+var searchIndex = 0;
+var searchCache = [];
+var searchString = '';
+var regexSearchString = '';
+var caseSensitiveMatch = false;
+var ignoreKeyCodeMin = 8;
+var ignoreKeyCodeMax = 46;
+var commandKey = 91;
+RegExp.escape = function(text) {
+    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+}
+function fullListSearch() {
+  // generate cache
+  searchCache = [];
+  $('#full_list li').each(function() {
+    var link = $(this).find('.object_link a');
+    var fullName = link.attr('title').split(' ')[0];
+    searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
+  });
+  $('#search input').keyup(function(event) {
+    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
+         || event.keyCode == commandKey)
+      return;
+    searchString = this.value;
+    caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
+    regexSearchString = RegExp.escape(searchString);
+    if (caseSensitiveMatch) {
+      regexSearchString += "|" +
+        $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
+        join('.+?');
+    }
+    if (searchString === "") {
+      clearTimeout(inSearch);
+      inSearch = null;
+      $('ul .search_uncollapsed').removeClass('search_uncollapsed');
+      $('#full_list, #content').removeClass('insearch');
+      $('#full_list li').removeClass('found').each(function() {
+        var link = $(this).find('.object_link a');
+        link.text(link.text());
+      });
+      if (clicked) {
+        clicked.parents('ul').each(function() {
+          $(this).removeClass('collapsed').prev().removeClass('collapsed');
+        });
+      }
+      highlight();
+    }
+    else {
+      if (inSearch) clearTimeout(inSearch);
+      searchIndex = 0;
+      lastRowClass = '';
+      $('#full_list, #content').addClass('insearch');
+      $('#noresults').text('');
+      searchItem();
+    }
+  });
+  $('#search input').focus();
+  $('#full_list').after("<div id='noresults'></div>");
+}
+var lastRowClass = '';
+function searchItem() {
+  for (var i = 0; i < searchCache.length / 50; i++) {
+    var item = searchCache[searchIndex];
+    var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
+    var matchString = regexSearchString;
+    var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
+    if (searchName.match(matchRegexp) == null) {
+      item.node.removeClass('found');
+    }
+    else {
+      item.node.css('padding-left', '10px').addClass('found');
+      item.node.parents().addClass('search_uncollapsed');
+      item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
+      lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
+      item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
+    }
+    if (searchCache.length === searchIndex + 1) {
+      searchDone();
+      return;
+    }
+    else {
+      searchIndex++;
+    }
+  }
+  inSearch = setTimeout('searchItem()', 0);
+}
+function searchDone() {
+  highlight(true);
+  if ($('#full_list li:visible').size() === 0) {
+    $('#noresults').text('No results were found.').hide().fadeIn();
+  }
+  else {
+    $('#noresults').text('');
+  }
+  $('#content').removeClass('insearch');
+  clearTimeout(inSearch);
+  inSearch = null;
+}
+clicked = null;
+function linkList() {
+  $('#full_list li, #full_list li a:last').click(function(evt) {
+    if ($(this).hasClass('toggle')) return true;
+    if (this.tagName.toLowerCase() == "li") {
+      var toggle = $(this).children('a.toggle');
+      if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
+        toggle.click();
+        return false;
+      }
+    }
+    if (clicked) clicked.removeClass('clicked');
+    var win = window.top.frames.main ? window.top.frames.main : window.parent;
+    if (this.tagName.toLowerCase() == "a") {
+      clicked = $(this).parent('li').addClass('clicked');
+      win.location = this.href;
+    }
+    else {
+      clicked = $(this).addClass('clicked');
+      win.location = $(this).find('a:last').attr('href');
+    }
+    return false;
+  });
+}
+function collapse() {
+  if (!$('#full_list').hasClass('class')) return;
+  $('#full_list.class a.toggle').click(function() {
+    $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
+    highlight();
+    return false;
+  });
+  $('#full_list.class ul').each(function() {
+    $(this).addClass('collapsed').prev().addClass('collapsed');
+  });
+  $('#full_list.class').children().removeClass('collapsed');
+  highlight();
+}
+function highlight(no_padding) {
+  var n = 1;
+  $('#full_list li:visible').each(function() {
+    var next = n == 1 ? 2 : 1;
+    $(this).removeClass("r" + next).addClass("r" + n);
+    if (!no_padding && $('#full_list').hasClass('class')) {
+      $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
+    }
+    n = next;
+  });
+}
+function escapeShortcut() {
+  $(document).keydown(function(evt) {
+    if (evt.which == 27) {
+      $('#search_frame', window.top.document).slideUp(100);
+      $('#search a', window.top.document).removeClass('active inactive');
+      $(window.top).focus();
+    }
+  });
+}
+$(escapeShortcut);
+$(fullListSearch);
+$(linkList);
+$(collapse);