Draiken/opinio

View on GitHub
doc/Opinio/CommentsController.html

Summary

Maintainability
Test Coverage
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

    <title>Class: Opinio::CommentsController</title>

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

    <script src="../js/jquery.js" type="text/javascript"
        charset="utf-8"></script>
    <script src="../js/thickbox-compressed.js" type="text/javascript"
        charset="utf-8"></script>
    <script src="../js/quicksearch.js" type="text/javascript"
        charset="utf-8"></script>
    <script src="../js/darkfish.js" type="text/javascript"
        charset="utf-8"></script>

</head>
<body class="class">

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

        <div id="file-metadata">
            <div id="file-list-section" class="section">
                <h3 class="section-header">In Files</h3>
                <div class="section-body">
                    <ul>
                    
                        <li><a href="../app/controllers/opinio/comments_controller_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
                            class="thickbox" title="app/controllers/opinio/comments_controller.rb">app/controllers/opinio/comments_controller.rb</a></li>
                    
                    </ul>
                </div>
            </div>

            
        </div>

        <div id="class-metadata">

            <!-- Parent Class -->
            
            <div id="parent-class-section" class="section">
                <h3 class="section-header">Parent</h3>
                
                <p class="link"><a href="../ApplicationController.html">ApplicationController</a></p>
                
            </div>
            

            <!-- Namespace Contents -->
            

            <!-- Method Quickref -->
            
            <div id="method-list-section" class="section">
                <h3 class="section-header">Methods</h3>
                <ul class="link-list">
                    
                    <li><a href="#method-i-create">#create</a></li>
                    
                    <li><a href="#method-i-destroy">#destroy</a></li>
                    
                    <li><a href="#method-i-index">#index</a></li>
                    
                </ul>
            </div>
            

            <!-- Included Modules -->
            
            <div id="includes-section" class="section">
                <h3 class="section-header">Included Modules</h3>
                <ul class="link-list">
                
                
                    <li><a class="include" href="Controllers/InternalHelpers.html">Opinio::Controllers::InternalHelpers</a></li>
                
                
                
                    <li><a class="include" href="Controllers/Replies.html">Opinio::Controllers::Replies</a></li>
                
                
                </ul>
            </div>
            
        </div>

        <div id="project-metadata">
            
            
            <div id="fileindex-section" class="section project-section">
                <h3 class="section-header">Files</h3>
                <ul>
                
                    <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
                
                    <li class="file"><a href="../MIT-LICENSE.html">MIT-LICENSE</a></li>
                
                    <li class="file"><a href="../README_rdoc.html">README.rdoc</a></li>
                
                    <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
                
                    <li class="file"><a href="../spec/dummy/Rakefile.html">Rakefile</a></li>
                
                </ul>
            </div>
            

            <div id="classindex-section" class="section project-section">
                <h3 class="section-header">Class Index
                    <span class="search-toggle"><img src="../images/find.png"
                        height="16" width="16" alt="[+]"
                        title="show/hide quicksearch" /></span></h3>
                <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
                <fieldset>
                    <legend>Quicksearch</legend>
                    <input type="text" name="quicksearch" value=""
                        class="quicksearch-field" />
                </fieldset>
                </form>

                <ul class="link-list">
                
                    <li><a href="../Opinio.html">Opinio</a></li>
                
                    <li><a href="../Opinio/CommentsController.html">Opinio::CommentsController</a></li>
                
                    <li><a href="../Opinio/Controllers.html">Opinio::Controllers</a></li>
                
                    <li><a href="../Opinio/Controllers/Extensions.html">Opinio::Controllers::Extensions</a></li>
                
                    <li><a href="../Opinio/Controllers/Extensions/ClassMethods.html">Opinio::Controllers::Extensions::ClassMethods</a></li>
                
                    <li><a href="../Opinio/Controllers/Extensions/InstanceMethods.html">Opinio::Controllers::Extensions::InstanceMethods</a></li>
                
                    <li><a href="../Opinio/Controllers/Helpers.html">Opinio::Controllers::Helpers</a></li>
                
                    <li><a href="../Opinio/Controllers/InternalHelpers.html">Opinio::Controllers::InternalHelpers</a></li>
                
                    <li><a href="../Opinio/Controllers/Replies.html">Opinio::Controllers::Replies</a></li>
                
                    <li><a href="../Opinio/Engine.html">Opinio::Engine</a></li>
                
                    <li><a href="../Opinio/Generators.html">Opinio::Generators</a></li>
                
                    <li><a href="../Opinio/Generators/InstallGenerator.html">Opinio::Generators::InstallGenerator</a></li>
                
                    <li><a href="../Opinio/Generators/ViewsGenerator.html">Opinio::Generators::ViewsGenerator</a></li>
                
                    <li><a href="../Opinio/OpinioModel.html">Opinio::OpinioModel</a></li>
                
                    <li><a href="../Opinio/OpinioModel/ClassMethods.html">Opinio::OpinioModel::ClassMethods</a></li>
                
                    <li><a href="../Opinio/OpinioModel/InstanceMethods.html">Opinio::OpinioModel::InstanceMethods</a></li>
                
                    <li><a href="../Opinio/OpinioSubjectum.html">Opinio::OpinioSubjectum</a></li>
                
                    <li><a href="../Opinio/OpinioSubjectum/ClassMethods.html">Opinio::OpinioSubjectum::ClassMethods</a></li>
                
                    <li><a href="../Opinio/OpinioSubjectum/InstanceMethods.html">Opinio::OpinioSubjectum::InstanceMethods</a></li>
                
                    <li><a href="../Opinio/Orm.html">Opinio::Orm</a></li>
                
                    <li><a href="../Opinio/Orm/ActiveRecord.html">Opinio::Orm::ActiveRecord</a></li>
                
                    <li><a href="../Opinio/Orm/ActiveRecord/Schema.html">Opinio::Orm::ActiveRecord::Schema</a></li>
                
                    <li><a href="../Opinio/Schema.html">Opinio::Schema</a></li>
                
                    <li><a href="../ActionDispatch.html">ActionDispatch</a></li>
                
                    <li><a href="../ActionDispatch/Routing.html">ActionDispatch::Routing</a></li>
                
                    <li><a href="../ActionDispatch/Routing/Mapper.html">ActionDispatch::Routing::Mapper</a></li>
                
                    <li><a href="../Dummy.html">Dummy</a></li>
                
                    <li><a href="../Dummy/Application.html">Dummy::Application</a></li>
                
                    <li><a href="../ApplicationController.html">ApplicationController</a></li>
                
                    <li><a href="../ApplicationHelper.html">ApplicationHelper</a></li>
                
                    <li><a href="../Comment.html">Comment</a></li>
                
                    <li><a href="../CreateComments.html">CreateComments</a></li>
                
                    <li><a href="../CreatePosts.html">CreatePosts</a></li>
                
                    <li><a href="../CreateUsers.html">CreateUsers</a></li>
                
                    <li><a href="../NavigationHelpers.html">NavigationHelpers</a></li>
                
                    <li><a href="../Post.html">Post</a></li>
                
                    <li><a href="../PostsController.html">PostsController</a></li>
                
                    <li><a href="../PostsHelper.html">PostsHelper</a></li>
                
                    <li><a href="../User.html">User</a></li>
                
                    <li><a href="../UsersController.html">UsersController</a></li>
                
                    <li><a href="../UsersHelper.html">UsersHelper</a></li>
                
                    <li><a href="../WithinHelpers.html">WithinHelpers</a></li>
                
                </ul>
                <div id="no-class-search-results" style="display: none;">No matching classes.</div>
            </div>

            
        </div>
    </div>

    <div id="documentation">
        <h1 class="class">Opinio::CommentsController</h1>

        <div id="description">
            
        </div>

        <!-- Constants -->
        

        <!-- Attributes -->
        

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

        
            <div id="create-method" class="method-detail ">
                <a name="method-i-create"></a>

                <div class="method-heading">
                
                    <span class="method-name">create</span><span
                        class="method-args">()</span>
                    <span class="method-click-advice">click to toggle source</span>
                
                </div>

                <div class="method-description">
                    
                    
                    

                    
                    <div class="method-source-code"
                        id="create-source">
<pre>
    <span class="ruby-comment cmt"># File app/controllers/opinio/comments_controller.rb, line 9</span>
 9:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create</span>
10:     <span class="ruby-ivar">@comment</span> = <span class="ruby-identifier">resource</span>.<span class="ruby-identifier">comments</span>.<span class="ruby-identifier">build</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:comment</span>])
11:     <span class="ruby-ivar">@comment</span>.<span class="ruby-identifier">owner</span> = <span class="ruby-identifier">current_user</span>
12:     <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@comment</span>.<span class="ruby-identifier">save</span>
13:       <span class="ruby-identifier">flash</span>[<span class="ruby-value">:notice</span>] = <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">translate</span>(<span class="ruby-value str">'opinio.comment.sent'</span>, <span class="ruby-value">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Comment sent successfully.&quot;</span>)
14:     <span class="ruby-keyword kw">else</span>
15:       <span class="ruby-identifier">flash</span>[<span class="ruby-value">:error</span>]  = <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">translate</span>(<span class="ruby-value str">'opinio.comment.error'</span>, <span class="ruby-value">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Error sending the comment.&quot;</span>)
16:     <span class="ruby-keyword kw">end</span>
17:   <span class="ruby-keyword kw">end</span></pre>
                    </div>
                    
                </div>

                

                
            </div>

        
            <div id="destroy-method" class="method-detail ">
                <a name="method-i-destroy"></a>

                <div class="method-heading">
                
                    <span class="method-name">destroy</span><span
                        class="method-args">()</span>
                    <span class="method-click-advice">click to toggle source</span>
                
                </div>

                <div class="method-description">
                    
                    
                    

                    
                    <div class="method-source-code"
                        id="destroy-source">
<pre>
    <span class="ruby-comment cmt"># File app/controllers/opinio/comments_controller.rb, line 19</span>
19:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">destroy</span>
20:     <span class="ruby-ivar">@comment</span> = <span class="ruby-constant">Opinio</span>.<span class="ruby-identifier">model_name</span>.<span class="ruby-identifier">constantize</span>.<span class="ruby-identifier">find</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:id</span>])
21: 
22:     <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">can_destroy_opinio?</span>(<span class="ruby-ivar">@comment</span>)
23:       <span class="ruby-ivar">@comment</span>.<span class="ruby-identifier">destroy</span>
24:       <span class="ruby-identifier">flash</span>[<span class="ruby-value">:notice</span>] = <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">translate</span>(<span class="ruby-value str">'opinio.comment.destroyed'</span>, <span class="ruby-value">:default</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;Comment removed successfully&quot;</span>)
25:     <span class="ruby-keyword kw">else</span>
26:       <span class="ruby-comment cmt">#flash[:error]  = I18n.translate('opinio.comment.not_permitted', :default =&gt; &quot;Not permitted&quot;)</span>
27:       <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">warning</span> <span class="ruby-node">&quot;user #{current_user.email} tried to remove a comment from another user #{@comment.owner.email}&quot;</span>
28:       <span class="ruby-identifier">render</span> <span class="ruby-value">:text</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value str">&quot;unauthorized&quot;</span>, <span class="ruby-value">:status</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-value">401</span>
29:     <span class="ruby-keyword kw">end</span>
30:   <span class="ruby-keyword kw">end</span></pre>
                    </div>
                    
                </div>

                

                
            </div>

        
            <div id="index-method" class="method-detail ">
                <a name="method-i-index"></a>

                <div class="method-heading">
                
                    <span class="method-name">index</span><span
                        class="method-args">()</span>
                    <span class="method-click-advice">click to toggle source</span>
                
                </div>

                <div class="method-description">
                    
                    
                    

                    
                    <div class="method-source-code"
                        id="index-source">
<pre>
   <span class="ruby-comment cmt"># File app/controllers/opinio/comments_controller.rb, line 5</span>
5:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">index</span>
6:     <span class="ruby-ivar">@comments</span> = <span class="ruby-identifier">resource</span>.<span class="ruby-identifier">comments</span>.<span class="ruby-identifier">page</span>(<span class="ruby-identifier">params</span>[<span class="ruby-value">:page</span>])
7:   <span class="ruby-keyword kw">end</span></pre>
                    </div>
                    
                </div>

                

                
            </div>

        
        </div>
    

    </div>


    <div id="rdoc-debugging-section-dump" class="debugging-section">
    
        <p>Disabled; run with --debug to generate this.</p>
    
    </div>

    <div id="validator-badges">
        <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
        <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
            Rdoc Generator</a> 1.1.6</small>.</p>
    </div>

</body>
</html>