muck-comments 0.1.0 → 0.1.1

data/README.rdoc

@@ -25,7 +25,7 @@ This let's you add any other methods to the comment model that you see fit.
 === Comment controller
 Override the comments controller to change the the security model.  For example:
 
-  class Muck::CommentsController < ApplicationController
+  class CommentsController < Muck::CommentsController
     
     before_filter :login_required # require the user to be logged in to make a comment
     
@@ -38,6 +38,18 @@ Override the comments controller to change the the security model.  For example:
     
   end
 
+=== Comment partial
+When calling create in the comments controller with :format => 'json' the resulting json will include an 'html' field that contains
+a rendered version of the comment html.  To facilitate this process be sure to create a partial called '_comment.html.erb' under a directory
+with the same name as the parent object.  The partial will be passed an object 'comment_owner' that references the parent object.
+
+For example, for an object 'activity' that acts_as_commentable create a partial 'activities/_comment.html.erb'.  The contents might look like this:
+
+  <div id="<%= comment.dom_id %>">
+    <span class="user"><%= link_to comment_owner.user, comment_owner.user %></span>
+    <p><%= h comment.body %></p>
+  </div>
+
 
 
 Copyright (c) 2009 Justin Ball, released under the MIT license

data/Rakefile

@@ -18,7 +18,7 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'MuckComments'
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/app/controllers/muck/comments_controller.rb

@@ -12,7 +12,7 @@ class Muck::CommentsController < ApplicationController
       format.html do
         redirect_back_or_default(@parent)
       end
-      format.json { render :json => { :success => true, :comment => @comment } }
+      format.json { render :json => { :success => true, :comment => @comment, :parent_id => @parent.id, :html => get_parent_comment_html(@parent) } }
     end
   rescue ActiveRecord::RecordInvalid => ex
     if @comment
@@ -37,6 +37,11 @@ class Muck::CommentsController < ApplicationController
         flash[:notice] = t('muck.comments.comment_removed')
         redirect_back_or_default(current_user)
       end
+      format.js do
+        render(:update) do |page|
+          page << "jQuery('##{@comment.dom_id}').fadeOut();"
+        end
+      end
       format.json { render :json => { :success => true, :message => t("muck.comments.comment_removed"), :comment_id => @comment.id } }
     end
   end  
@@ -68,6 +73,16 @@ class Muck::CommentsController < ApplicationController
     end
   end
 
+  def get_parent_comment_html(parent)
+    old_format = @template.template_format
+    @template.template_format = :html
+    comment = render_to_string(:partial => "#{parent.class.to_s.tableize}/comment", :locals => {:comment_owner => parent})
+    @template.template_format = old_format
+    comment
+  rescue ActionView::MissingTemplate
+    I18n.t('muck.comments.missing_comment_template_error', :partial => "#{parent.class.to_s.tableize}/comment")
+  end
+  
   def has_permission_to_comment(user, parent)
     parent.can_comment?(user)
   end

data/app/views/activity_templates/_comment.html.erb

@@ -1,6 +1,7 @@
 <div class="activity activity-status-update delete-container" id="<%= activity.dom_id %>">
   <div class="actor-icon"><%= icon activity.source %></div>
   <div class="activity-content">
+    <% #TODO build out comment activity template %>
     <p><span class="actor"><%= link_to activity.source.display_name, activity.source %></span> <%= activity.content %></p>
     <span class="activity-time"><%= t("muck.activities.time_ago", :time_in_words => time_ago_in_words(activity.created_at)) %></span>
     <%= delete_activity(activity, :image) %>

data/app/views/comments/_form.html.erb

@@ -2,6 +2,6 @@
   <% form_for(:comment, :url => new_comment_path_with_parent(parent), :html => { :id => "#{parent.dom_id}_comment_form", :class => "comment-form"} ) do |f| -%>
     <%= f.text_area :body, :class => 'min' %>
     <%= hidden_field_tag :parent_comment_id, comment.id unless comment.blank? -%>
-    <%= f.submit t('muck.comments.add_comment'), :class => "button" %>
+    <%= f.submit t('muck.comments.add_comment'), :class => "button comment-submit", :id => "comment_submit_#{parent.dom_id}" %>
   <% end -%>
 </div>

data/locales/en.yml

@@ -5,4 +5,5 @@ en:
       missing_parent_id_error: "Please specify a parent object"
       comment_removed: "Comment successfully removed."
       create_error: "Could not create the comment {{errors}}"
-      add_comment: "Comment"
+      add_comment: "Comment"
+      missing_comment_template_error: "Could not find a partial named {{partial}}.  Please create a comment partial and try again."

data/muck-comments.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{muck-comments}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Justin Ball"]
-  s.date = %q{2009-06-13}
+  s.date = %q{2009-06-16}
   s.description = %q{The comment engine for the muck system.}
   s.email = %q{justinball@gmail.com}
   s.extra_rdoc_files = [
@@ -47,9 +47,33 @@ Gem::Specification.new do |s|
      "locales/en.yml",
      "locales/en.yml",
      "muck-comments.gemspec",
-     "pkg/muck-comments-0.1.0.gem",
+     "pkg/muck-comments-0.1.1.gem",
      "rails/init.rb",
      "rails/init.rb",
+     "rdoc/classes/ActionController.html",
+     "rdoc/classes/ActionController/Routing.html",
+     "rdoc/classes/ActionController/Routing/RouteSet.html",
+     "rdoc/classes/ActiveRecord.html",
+     "rdoc/classes/ActiveRecord/Acts/MuckComment/ClassMethods.html",
+     "rdoc/classes/ActiveRecord/Acts/MuckComment/InstanceMethods.html",
+     "rdoc/classes/ActiveRecord/Acts/MuckComment/SingletonMethods.html",
+     "rdoc/classes/Acts/CommentableWithThreading/ClassMethods.html",
+     "rdoc/classes/Acts/CommentableWithThreading/InstanceMethods.html",
+     "rdoc/classes/Acts/CommentableWithThreading/SingletonMethods.html",
+     "rdoc/classes/MuckComments.html",
+     "rdoc/classes/MuckComments/Tasks.html",
+     "rdoc/created.rid",
+     "rdoc/files/README_rdoc.html",
+     "rdoc/files/lib/active_record/acts/muck_comment_rb.html",
+     "rdoc/files/lib/acts_as_commentable_with_threading_rb.html",
+     "rdoc/files/lib/muck_comments/initialize_routes_rb.html",
+     "rdoc/files/lib/muck_comments/tasks_rb.html",
+     "rdoc/files/lib/muck_comments_rb.html",
+     "rdoc/fr_class_index.html",
+     "rdoc/fr_file_index.html",
+     "rdoc/fr_method_index.html",
+     "rdoc/index.html",
+     "rdoc/rdoc-style.css",
      "tasks/muck_comments_tasks.rake",
      "tasks/muck_comments_tasks.rake",
      "test/db/database.yml",

data/rdoc/classes/ActionController/Routing/RouteSet.html

@@ -0,0 +1,148 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+  <title>Class: ActionController::Routing::RouteSet</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">ActionController::Routing::RouteSet</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/muck_comments/initialize_routes_rb.html">
+                lib/muck_comments/initialize_routes.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000001">load_routes_with_muck_comments!</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="#M000001" class="method-signature">
+          <span class="method-name">load_routes_with_muck_comments!</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000001-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000001-source">
+<pre>
+   <span class="ruby-comment cmt"># File lib/muck_comments/initialize_routes.rb, line 2</span>
+2:   <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">load_routes_with_muck_comments!</span>
+3:     <span class="ruby-identifier">muck_comments_routes</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-operator">*</span><span class="ruby-node">%w[.. .. config muck_comments_routes.rb]</span>)
+4:     <span class="ruby-identifier">add_configuration_file</span>(<span class="ruby-identifier">muck_comments_routes</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">configuration_files</span>.<span class="ruby-identifier">include?</span> <span class="ruby-identifier">muck_comments_routes</span>
+5:     <span class="ruby-identifier">load_routes_without_muck_comments!</span>
+6:   <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/ActionController/Routing.html

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+  <title>Module: ActionController::Routing</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">ActionController::Routing</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="Routing/RouteSet.html" class="link">ActionController::Routing::RouteSet</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/rdoc/classes/ActionController.html

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!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>
+  <title>Module: ActionController</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">ActionController</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Module <a href="ActionController/Routing.html" class="link">ActionController::Routing</a><br />
+
+    </div>
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>