RubyGems - zen - Versions diffs - 0.1a → 0.2 - Mend

zen 0.1a → 0.2

Files changed (414) hide show

data/doc/Comments/Liquid/Comments.html DELETED

@@ -1,543 +0,0 @@
-<!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 name="Content-Type" content="text/html; charset=utf-8" />
-<title>Class: Comments::Liquid::Comments</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">
-  relpath = '../..';
-  if (relpath != '') 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>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../../_index.html">Index (C)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../Comments.html" title="Comments (module)">Comments</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Liquid.html" title="Comments::Liquid (module)">Liquid</a></span></span>
-     &raquo;
-    <span class="title">Comments</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 id="class_list_link" href="#">Class List</a>
-  <a id="method_list_link" href="#">Method List</a>
-  <a id ="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Comments::Liquid::Comments
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Liquid::Block</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Liquid::Block</li>
-            <li class="next">Comments::Liquid::Comments</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Includes:</dt>
-      <dd class="r2">Ramaze::Helper::CGI, <span class='object_link'><a href="../../Zen/Liquid/General.html" title="Zen::Liquid::General (module)">Zen::Liquid::General</a></span></dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/packages/comments/lib/comments/liquid/comments.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>Tag that can be used to display a number of comments based on the section entry ID
-or the slug of a section entry.</p>
-<p>The following arguments can be used for this tag:</p>
-<ul>
-	<li>section_entry: the slug of the section entry for which to retrieve all comments</li>
-	<li>limit: the amount of comments to retriee</li>
-	<li>offset: the offset from which to start retrieving comments</li>
-</ul>
-  </div>
-</div>
-<div class="tags">
-  <div class="examples">
-    <h3>Examples:</h3>
-      <h4><div class='inline'></div></h4>
-      <pre class="example code">
-{% comments section_entry=&quot;hello-world&quot; limit=&quot;10&quot; %}
-  {{comment}}
-{% endcomments %}</pre>
-  </div>
-<h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</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="#initialize-instance_method" title="#initialize (instance method)">- (Comments) <strong>initialize</strong>(tag_name, arguments, html) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'><p>Creates a new instance of the block and passes the tag name,
-all additional arguments and the <span class="caps">HTML</span> to the constructor method.</p></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#render-instance_method" title="#render (instance method)">- (Object) <strong>render</strong>(context) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Retrieves all comments and renders the tag block.</p></div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="../../Zen/Liquid/General.html" title="Zen::Liquid::General (module)">Zen::Liquid::General</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="../../Zen/Liquid/General.html#markup_to_html-instance_method" title="Zen::Liquid::General#markup_to_html (method)">#markup_to_html</a></span>, <span class='object_link'><a href="../../Zen/Liquid/General.html#parse_key_values-instance_method" title="Zen::Liquid::General#parse_key_values (method)">#parse_key_values</a></span></p>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <p class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Comments::Liquid::Comments (class)">Comments</a></span></tt>) <strong>initialize</strong>(tag_name, arguments, html)
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Creates a new instance of the block and passes the tag name,
-all additional arguments and the <span class="caps">HTML</span> to the constructor method.</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Parameters:</h3>
-<ul class="param">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        <span class='name'>tag_name</span>
-        &mdash;
-        <div class='inline'><p>The name of the tag that was called.</p></div>
-    </li>
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        <span class='name'>arguments</span>
-        &mdash;
-        <div class='inline'><p>All additional arguments passed as a string.</p></div>
-    </li>
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        <span class='name'>html</span>
-        &mdash;
-        <div class='inline'><p>The <span class="caps">HTML</span> inside the block.</p></div>
-    </li>
-</ul>
-<h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-36
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/packages/comments/lib/comments/liquid/comments.rb', line 36</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span> <span class='id tag_name'>tag_name</span><span class='comma'>,</span> <span class='id arguments'>arguments</span><span class='comma'>,</span> <span class='id html'>html</span>
-  <span class='kw'>super</span>
-  <span class='ivar'>@arguments</span> <span class='op'>=</span> <span class='lbrace'>{</span>
-    <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>limit</span><span class='tstring_end'>'</span></span>  <span class='op'>=&gt;</span> <span class='kw'>nil</span><span class='comma'>,</span>
-    <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>offset</span><span class='tstring_end'>'</span></span> <span class='op'>=&gt;</span> <span class='kw'>nil</span>
-  <span class='rbrace'>}</span><span class='period'>.</span><span class='id merge'>merge</span><span class='lparen'>(</span><span class='id parse_key_values'>parse_key_values</span><span class='lparen'>(</span><span class='id arguments'>arguments</span><span class='rparen'>)</span><span class='rparen'>)</span>
-  <span class='ivar'>@args_parsed</span> <span class='op'>=</span> <span class='kw'>false</span>
-  <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@arguments</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>section_entry</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>or</span> <span class='ivar'>@arguments</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>section_entry</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id empty?'>empty?</span>
-    <span class='id raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>You need to specify a section entry's slug in order to retrieve a set of comments</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 id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="render-instance_method">
-    - (<tt>Object</tt>) <strong>render</strong>(context)
-</p><div class="docstring">
-  <div class="discussion">
-    <p>Retrieves all comments and renders the tag block.</p>
-  </div>
-</div>
-<div class="tags">
-  <h3>Author:</h3>
-<ul class="author">
-    <li>
-        <div class='inline'><p>Yorick Peterse</p></div>
-    </li>
-</ul>
-<h3>Since:</h3>
-<ul class="since">
-    <li>
-        <div class='inline'><p>0.1</p></div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
-74
-75
-76
-77
-78
-79
-80
-81
-82
-83
-84
-85
-86
-87
-88
-89
-90
-91
-92
-93
-94
-95
-96
-97
-98
-99
-100
-101
-102
-103
-104
-105
-106
-107
-108
-109
-110
-111</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '/Applications/MAMP/htdocs/ruby/zen/zen/lib/zen/packages/comments/lib/comments/liquid/comments.rb', line 57</span>
-<span class='kw'>def</span> <span class='id render'>render</span> <span class='id context'>context</span>
-  <span class='kw'>if</span> <span class='ivar'>@args_parsed</span> <span class='op'>==</span> <span class='kw'>false</span>
-    <span class='ivar'>@arguments</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span>
-      <span class='id v'>v</span> <span class='op'>=</span> <span class='id v'>v</span><span class='period'>.</span><span class='id to_s'>to_s</span>
-      <span class='kw'>if</span> <span class='id context'>context</span><span class='period'>.</span><span class='id has_key?'>has_key?</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span>
-        <span class='ivar'>@arguments</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id h'>h</span><span class='lparen'>(</span><span class='id context'>context</span><span class='lbracket'>[</span><span class='id v'>v</span><span class='rbracket'>]</span><span class='rparen'>)</span>
-      <span class='kw'>end</span>
-    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='ivar'>@args_parsed</span> <span class='op'>=</span> <span class='kw'>true</span>
-  <span class='id result'>result</span>       <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='id filter_hash'>filter_hash</span>  <span class='op'>=</span> <span class='lbrace'>{</span><span class='symbol'>:status</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>open</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span>
-  <span class='id comments'>comments</span>     <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
-  <span class='id format'>format</span>       <span class='op'>=</span> <span class='kw'>nil</span>
-  <span class='kw'>if</span> <span class='ivar'>@arguments</span><span class='period'>.</span><span class='id key?'>key?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>section_entry</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-    <span class='id entry'>entry</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Sections</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>SectionEntry</span><span class='lbracket'>[</span><span class='symbol'>:slug</span> <span class='op'>=&gt;</span> <span class='ivar'>@arguments</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>section_entry</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span>
-    <span class='kw'>return</span> <span class='kw'>if</span> <span class='id entry'>entry</span><span class='period'>.</span><span class='id nil?'>nil?</span>
-    <span class='id filter_hash'>filter_hash</span><span class='lbracket'>[</span><span class='symbol'>:section_entry_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id entry'>entry</span><span class='period'>.</span><span class='id id'>id</span>
-  <span class='kw'>end</span>
-  <span class='id comments'>comments</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'>Comments</span><span class='op'>::</span><span class='const'>Models</span><span class='op'>::</span><span class='const'>Comment</span><span class='period'>
-</span><span class='period'>    .</span><span class='id eager'>eager</span><span class='lparen'>(</span><span class='symbol'>:user</span><span class='comma'>,</span> <span class='symbol'>:section_entry</span><span class='rparen'>)</span><span class='period'>
-</span><span class='period'>    .</span><span class='id filter'>filter</span><span class='lparen'>(</span><span class='id filter_hash'>filter_hash</span><span class='rparen'>)</span><span class='period'>
-</span><span class='period'>    .</span><span class='id limit'>limit</span><span class='lparen'>(</span><span class='ivar'>@arguments</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>limit</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='ivar'>@arguments</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>offset</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='rparen'>)</span>
-  <span class='id context'>context</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>total_rows</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id comments'>comments</span><span class='period'>.</span><span class='id count'>count</span>
-  <span class='id comments'>comments</span><span class='period'>.</span><span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id comment'>comment</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span>
-    <span class='id context'>context</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>index</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id index'>index</span>
-    <span class='kw'>if</span> <span class='id format'>format</span><span class='period'>.</span><span class='id nil?'>nil?</span>
-      <span class='id section'>section</span> <span class='op'>=</span> <span class='id comment'>comment</span><span class='period'>.</span><span class='id section_entry'>section_entry</span><span class='period'>.</span><span class='id section'>section</span>
-      <span class='id format'>format</span>  <span class='op'>=</span> <span class='id section'>section</span><span class='period'>.</span><span class='id comment_format'>comment_format</span>
-    <span class='kw'>end</span>
-    <span class='id comment'>comment</span><span class='period'>.</span><span class='id values'>values</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id v'>v</span><span class='op'>|</span> <span class='id context'>context</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id v'>v</span> <span class='rbrace'>}</span>
-    <span class='comment'># Convert the comment body into HTML
-</span>    <span class='id context'>context</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>comment</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id markup_to_html'>markup_to_html</span><span class='lparen'>(</span><span class='id context'>context</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>comment</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id format'>format</span><span class='rparen'>)</span>
-    <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>email</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>name</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>website</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id c'>c</span><span class='op'>|</span>
-      <span class='kw'>if</span> <span class='id context'>context</span><span class='lbracket'>[</span><span class='id c'>c</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> <span class='kw'>or</span> <span class='id context'>context</span><span class='lbracket'>[</span><span class='id c'>c</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id empty?'>empty?</span>
-        <span class='id context'>context</span><span class='lbracket'>[</span><span class='id c'>c</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id comment'>comment</span><span class='period'>.</span><span class='id user'>user</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id c'>c</span><span class='rparen'>)</span>
-      <span class='kw'>end</span>
-    <span class='kw'>end</span>
-    <span class='id result'>result</span> <span class='op'>&lt;&lt;</span> <span class='id render_all'>render_all</span><span class='lparen'>(</span><span class='ivar'>@nodelist</span><span class='comma'>,</span> <span class='id context'>context</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-  <span class='kw'>return</span> <span class='id result'>result</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Sun Feb  6 21:24:01 2011 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.6.4 (ruby-1.9.2).
-</div>
-  </body>
-</html>