Draiken/opinio

View on GitHub
rdoc/Opinio/Controllers/Helpers.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>

<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">

<title>module Opinio::Controllers::Helpers - Opinio</title>

<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../";
</script>

<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>


<body id="top" class="module">
<nav id="metadata">
  <nav id="home-section" class="section">
  <h3 class="section-header">
    <a href="../../index.html">Home</a>
    <a href="../../table_of_contents.html#classes">Classes</a>
    <a href="../../table_of_contents.html#methods">Methods</a>
  </h3>
</nav>


  <nav id="search-section" class="section project-section" class="initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <h3 class="section-header">
      <input type="text" name="search" placeholder="Search" id="search-field"
             title="Type to search, Up and Down to navigate, Enter to load">
    </h3>
  </form>

  <ul id="search-results" class="initially-hidden"></ul>
</nav>


  <div id="file-metadata">
    <nav id="file-list-section" class="section">
  <h3 class="section-header">Defined In</h3>
  <ul>
    <li>lib/opinio/controllers/helpers.rb
  </ul>
</nav>

    
  </div>

  <div id="class-metadata">
    
    
    
    <!-- Method Quickref -->
<nav id="method-list-section" class="section">
  <h3 class="section-header">Methods</h3>

  <ul class="link-list">
    
    <li><a href="#method-i-comments_for">#comments_for</a>
    
    <li><a href="#method-i-render_comments">#render_comments</a>
    
    <li><a href="#method-i-render_comments_form">#render_comments_form</a>
    
  </ul>
</nav>

  </div>

  <div id="project-metadata">
    <nav id="fileindex-section" class="section project-section">
  <h3 class="section-header">Pages</h3>

  <ul>
  
    <li class="file"><a href="../../README_rdoc.html">README</a>
  
  </ul>
</nav>

    <nav id="classindex-section" class="section project-section">
  <h3 class="section-header">Class and Module Index</h3>

  <ul class="link-list">
  
    <li><a href="../../Opinio.html">Opinio</a>
  
    <li><a href="../../Opinio/Controllers.html">Opinio::Controllers</a>
  
    <li><a href="../../Opinio/Controllers/Extensions.html">Opinio::Controllers::Extensions</a>
  
    <li><a href="../../Opinio/Controllers/Extensions/ClassMethods.html">Opinio::Controllers::Extensions::ClassMethods</a>
  
    <li><a href="../../Opinio/Controllers/Extensions/InstanceMethods.html">Opinio::Controllers::Extensions::InstanceMethods</a>
  
    <li><a href="../../Opinio/Controllers/Helpers.html">Opinio::Controllers::Helpers</a>
  
    <li><a href="../../Opinio/Controllers/InternalHelpers.html">Opinio::Controllers::InternalHelpers</a>
  
    <li><a href="../../Opinio/Controllers/Replies.html">Opinio::Controllers::Replies</a>
  
    <li><a href="../../Opinio/Engine.html">Opinio::Engine</a>
  
    <li><a href="../../Opinio/Generators.html">Opinio::Generators</a>
  
    <li><a href="../../Opinio/Generators/InstallGenerator.html">Opinio::Generators::InstallGenerator</a>
  
    <li><a href="../../Opinio/Generators/ViewsGenerator.html">Opinio::Generators::ViewsGenerator</a>
  
    <li><a href="../../Opinio/OpinioModel.html">Opinio::OpinioModel</a>
  
    <li><a href="../../Opinio/OpinioModel/ClassMethods.html">Opinio::OpinioModel::ClassMethods</a>
  
    <li><a href="../../Opinio/OpinioModel/RepliesSupport.html">Opinio::OpinioModel::RepliesSupport</a>
  
    <li><a href="../../Opinio/OpinioModel/Sanitizing.html">Opinio::OpinioModel::Sanitizing</a>
  
    <li><a href="../../Opinio/OpinioModel/Validations.html">Opinio::OpinioModel::Validations</a>
  
    <li><a href="../../Opinio/OpinioModel/Validations/IntervalMethods.html">Opinio::OpinioModel::Validations::IntervalMethods</a>
  
    <li><a href="../../Opinio/OpinioSubjectum.html">Opinio::OpinioSubjectum</a>
  
    <li><a href="../../Opinio/OpinioSubjectum/ClassMethods.html">Opinio::OpinioSubjectum::ClassMethods</a>
  
    <li><a href="../../Opinio/Orm.html">Opinio::Orm</a>
  
    <li><a href="../../Opinio/Orm/ActiveRecord.html">Opinio::Orm::ActiveRecord</a>
  
    <li><a href="../../Opinio/Orm/ActiveRecord/Schema.html">Opinio::Orm::ActiveRecord::Schema</a>
  
    <li><a href="../../Opinio/Schema.html">Opinio::Schema</a>
  
    <li><a href="../../Opinio/Version.html">Opinio::Version</a>
  
    <li><a href="../../ActionDispatch.html">ActionDispatch</a>
  
    <li><a href="../../ActionDispatch/Routing.html">ActionDispatch::Routing</a>
  
    <li><a href="../../ActionDispatch/Routing/Mapper.html">ActionDispatch::Routing::Mapper</a>
  
    <li><a href="../../Create.html">Create</a>
  
    <li><a href="../../NoSanitizerComment.html">NoSanitizerComment</a>
  
    <li><a href="../../Object.html">Object</a>
  
  </ul>
</nav>

  </div>
</nav>

<div id="documentation">
  <h1 class="module">module Opinio::Controllers::Helpers</h1>

  <div id="description" class="description">
    
  </div><!-- description -->

  
  
  
  <section id="5Buntitled-5D" class="documentation-section">
    

    

    

    

    <!-- Methods -->
    
     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
      <h3 class="section-header">Public Instance Methods</h3>

    
      <div id="method-i-comments_for" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">comments_for</span><span
            class="method-args">(object, options = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="comments_for-source">
            <pre><span class="ruby-comment"># File lib/opinio/controllers/helpers.rb, line 5</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">comments_for</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">options</span> = {})        
  <span class="ruby-identifier">render_comments</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">options</span>) <span class="ruby-operator">+</span>
  ( <span class="ruby-identifier">render_comments_form</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:no_new</span>] ).<span class="ruby-identifier">to_s</span>
<span class="ruby-keyword">end</span></pre>
          </div><!-- comments_for-source -->
          
        </div>

        

        
      </div><!-- comments_for-method -->

    
      <div id="method-i-render_comments" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">render_comments</span><span
            class="method-args">(object, options = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="render_comments-source">
            <pre><span class="ruby-comment"># File lib/opinio/controllers/helpers.rb, line 10</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">render_comments</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">options</span> = {})
  <span class="ruby-identifier">limit</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:limit</span>) <span class="ruby-operator">||</span> <span class="ruby-constant">Opinio</span>.<span class="ruby-identifier">model_name</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">default_per_page</span>
  <span class="ruby-identifier">page</span>  = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:page</span>)  <span class="ruby-operator">||</span> <span class="ruby-value">1</span>
  <span class="ruby-identifier">render</span>( <span class="ruby-value">:partial</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;opinio/comments/comments&quot;</span>, <span class="ruby-value">:locals</span> =<span class="ruby-operator">&gt;</span> {<span class="ruby-value">:comments</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">object</span>.<span class="ruby-identifier">comments</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">page</span>).<span class="ruby-identifier">limit</span>(<span class="ruby-identifier">limit</span>), <span class="ruby-value">:commentable</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">object</span>, <span class="ruby-value">:options</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">options</span>} )
<span class="ruby-keyword">end</span></pre>
          </div><!-- render_comments-source -->
          
        </div>

        

        
      </div><!-- render_comments-method -->

    
      <div id="method-i-render_comments_form" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">render_comments_form</span><span
            class="method-args">(object, options = {})</span>
          <span class="method-click-advice">click to toggle source</span>
        </div>
        

        <div class="method-description">
          
          
          

          
          <div class="method-source-code" id="render_comments_form-source">
            <pre><span class="ruby-comment"># File lib/opinio/controllers/helpers.rb, line 16</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">render_comments_form</span>(<span class="ruby-identifier">object</span>, <span class="ruby-identifier">options</span> = {})
  <span class="ruby-identifier">render</span>( <span class="ruby-value">:partial</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;opinio/comments/new&quot;</span>, <span class="ruby-value">:locals</span> =<span class="ruby-operator">&gt;</span> {<span class="ruby-value">:commentable</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">object</span>, <span class="ruby-value">:options</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">options</span>} )
<span class="ruby-keyword">end</span></pre>
          </div><!-- render_comments_form-source -->
          
        </div>

        

        
      </div><!-- render_comments_form-method -->

    
    </section><!-- public-instance-method-details -->
  
  </section><!-- 5Buntitled-5D -->

</div><!-- documentation -->


<footer id="validator-badges">
  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>