muck-comments 0.1.6 → 0.1.7

data/.gitignore

@@ -2,3 +2,4 @@
 coverage
 rdoc
 pkg
+log/*

data/README.rdoc

@@ -38,6 +38,30 @@ Override the comments controller to change the the security model.  For example:
     
   end
 
+=== Attach comments to a model:
+
+For a given model add 'acts_as_commentable'
+  class Blog < ActiveRecord::Base
+    acts_as_commentable
+  end
+
+'acts_as_commentable' will automatically track the count, but you will need to add a column to your table called comment_count:
+
+  class AddCommentCache < ActiveRecord::Migration
+    def self.up
+      add_column :blogs, :comment_count, :integer, :default => 0
+    end
+
+    def self.down
+      remove_column :blogs, :comment_count
+    end
+  end
+
+Then you will be able to do this to get a comment count:
+  
+  @blog.comment_count
+
+
 === 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

data/Rakefile

@@ -8,8 +8,8 @@ task :default => :test
 desc 'Test muck-comments.'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << 'test/rails_root/test'
+  t.pattern = 'test/rails_root/test/**/*_test.rb'
   t.verbose = true
 end
 
@@ -56,15 +56,6 @@ begin
     gemspec.rubyforge_project = 'muck-comments'
     gemspec.add_dependency "muck-engine"
     gemspec.add_dependency "muck-users"
-    # gemspec.files.include %w( tasks/*
-    #                       db/migrate/*.rb
-    #                       app/**/**/**/*
-    #                       config/*
-    #                       locales/*
-    #                       rails/*
-    #                       test/*
-    #                       lib/**/*
-    #                       public/javascripts/* )
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/app/controllers/muck/comments_controller.rb

@@ -1,33 +1,50 @@
 class Muck::CommentsController < ApplicationController
   unloadable
   
-  before_filter :get_parent, :only => [:create]
+  before_filter :setup_parent, :only => [:new, :create]
+  before_filter :has_permission?, :only => [:new, :create]
   before_filter :get_comment, :only => [:destroy]
-
+  
+  def index
+    @parent = get_parent
+    @comment = Comment.find(params[:id]) rescue nil
+    @comments = @parent.comments.by_newest if !@parent.blank?
+    @comments ||= @comment.children if !@comment.blank?
+    
+    respond_to do |format|
+      format.html { render :template => 'comments/index', :layout => 'popup' }
+      format.pjs { render :template => 'comments/index', :layout => false }
+    end
+  end
+  
+  def new
+    title = @parent.title rescue ''
+    title ||= @parent.name rescue ''
+    if title.blank?
+      @page_title = t('muck.comments.new_comment_no_title')
+    else
+      @page_title = t('muck.comments.new_comment_with_title', :title => title)
+    end
+    respond_to do |format|
+      format.html { render :template => 'comments/new', :layout => 'popup' }
+      format.pjs { render :template => 'comments/new', :layout => false }
+    end
+  end
+  
   def create
     @comment = @parent.comments.build(params[:comment])
     @comment.user = current_user
     @comment.save!
-    respond_to do |format|
-      format.html do
-        redirect_back_or_default(@parent)
-      end
-      format.json { render :json => { :success => true, :comment => @comment, :parent_id => @parent.id, :html => get_parent_comment_html(@parent) } }
-    end
+    message = t('muck.comments.create_success')
+    handle_after_create(true, message)
   rescue ActiveRecord::RecordInvalid => ex
     if @comment
-      @errors = @comment.errors.full_messages.to_sentence
+      errors = @comment.errors.full_messages.to_sentence
     else
-      @errors = ex
-    end
-    message = t('muck.comments.create_error', :errors => @errors)
-    respond_to do |format|
-      format.html do
-        flash[:error] = message
-        redirect_back_or_default(@parent)
-      end
-      format.json { render :json => { :success => false, :message => message, :errors => @errors } }
+      errors = ex
     end
+    message = t('muck.comments.create_error', :errors => errors)
+    handle_after_create(false, message)
   end
 
   def destroy
@@ -48,18 +65,30 @@ class Muck::CommentsController < ApplicationController
 
   protected
 
-  def get_parent
-    if !params[:parent_type] || !params[:parent_id]
-      raise t('muck.comments.missing_parent_id_error')
-      return
+  def handle_after_create(success, message = '')
+    if success
+      respond_to do |format|
+        format.html { do_after_create_action(success, message) }
+        format.json { render :json => { :success => true, :comment => @comment, :message => message, :parent_id => @parent.id, :html => get_parent_comment_html(@parent, @comment) } }
+      end
+    else
+      respond_to do |format|
+        format.html { do_after_create_action }
+        format.json { render :json => { :success => false, :message => message, :errors => @errors } }
+      end
     end
-    @klass = params[:parent_type].to_s.constantize
-    @parent = @klass.find(params[:parent_id])
-    unless has_permission_to_comment(current_user, @parent)
-      permission_denied
+  end
+  
+  def do_after_create_action(success, message)
+    flash[:error] = message if !success
+    if "true" == params[:render_new]
+      flash[:notice] = message if success
+      render :template => 'comments/new'
+    else
+      redirect_back_or_default(@parent)
     end
   end
-
+  
   def get_comment
     @comment = Comment.find(params[:id])
     unless @comment.can_edit?(current_user)
@@ -73,18 +102,19 @@ 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
+  def get_parent_comment_html(parent, comment)
+    render_as_html do
+      render_to_string(:partial => "#{parent.class.to_s.tableize}/comment", :object => comment, :locals => {:comment_owner => parent})
+    end
   rescue ActionView::MissingTemplate
-    I18n.t('muck.comments.missing_comment_template_error', :partial => "#{parent.class.to_s.tableize}/comment")
+    render_as_html do
+      render_to_string(:partial => "comments/comment", :object => comment, :locals => {:comment_owner => parent})
+    end
+    #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)
+  def has_permission?
+    @parent.can_comment?(current_user)
   end
   
 end

data/app/helpers/muck_comments_helper.rb

@@ -1,17 +1,35 @@
 module MuckCommentsHelper
   
+  def show_comments(comments)
+    render :partial => 'comments/comment', :collection => comments
+  end
+  
   # parent is the object to which the comments will be attached
   # comment is the optional parent comment for the new comment.
-  def comment_form(parent, comment = nil)
-    render :partial => 'comments/form', :locals => {:parent => parent, :comment => comment}
+  def comment_form(parent, comment = nil, render_new = false)
+    render :partial => 'comments/form', :locals => {:parent => parent, 
+                                                    :comment => comment, 
+                                                    :render_new => render_new}
   end
 
+  # make_muck_parent_params is defined in muck-engine and used by many of the engines.
+  # This will generate a url suitable for a form to post a create to.
   def new_comment_path_with_parent(parent)
-    comments_path(make_parent_params(parent))
+    comments_path(make_muck_parent_params(parent))
+  end
+  
+  # Generates a link to the 'new' page for a comment
+  def new_comment_for_path(parent)
+    new_comment_path(make_muck_parent_params(parent))
   end
   
-  def make_parent_params(parent)
-    { :parent_id => parent.id, :parent_type => parent.class.to_s }
+  # Renders a delete button for a comment
+  def delete_comment(comment, button_type = :button, button_text = t("muck.activities.delete"))
+    render :partial => 'shared/delete', :locals => { :delete_object => comment, 
+                                                         :button_type => button_type,
+                                                         :button_text => button_text, 
+                                                         :form_class => 'comment-delete',
+                                                         :delete_path => comment_path(comment, :format => 'js') }
   end
   
 end

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

@@ -1,9 +1,3 @@
-<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) %>
-  </div>
-</div>
+<% activity_for(activity, :activity_css_class => 'activity-comment') do -%>
+  <%= activity.item.body %>
+<% end -%>

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

@@ -1,26 +1,7 @@
-<%-
-comment ||= @comment
-return if comment.user.nil?
-truncate = false
-youtube_videos = comment.comment.scan(/\[youtube:+.+\]/)
-c = comment.comment.dup.gsub(/\[youtube:+.+\]/, '')
--%>
-
-<div id="<%= comment.dom_id %>" class="comment_holder">
-  <%= icon comment.user, :small, :class => 'left avatar_on_comment' %> 
-  <div class="date_details">
-    <%= _("%{comment_age} ago %{user_name_link} wrote :") % {:comment_age => time_ago_in_words(comment.created_at), :user_name_link => (link_to h(comment.user.full_name), profile_path(comment.user))} %> 
-  </div>
-  <div class="comment_message">
-    <%= sanitize(textilize(c)) %>
-		<%= x_comment_link(comment) -%>
-  </div>
-	
-  <% unless youtube_videos.empty? %>
-    <strong><%= pluralize youtube_videos.size, 'video' %>:</strong><br/>
-    <% youtube_videos.each do |o| %>
-    <%= tb_video_link(o.gsub!(/\[youtube\:|\]/, '')) %>
-  <% end
-  end %>
-  <div class="clear"></div>
+<div id="<%= comment.dom_id %>" class="comment_holder delete-container">
+  <div class="commentor-icon"><%= icon comment.user %></div>
+  <p><span class="commentor"><%= link_to comment.user.try(:display_name), comment.user %></span>
+    <%= h comment.body %></p>
+  <%= delete_comment(comment, :image) if comment.can_edit?(current_user) %>
+  <span class="comment-time"><%= t("muck.general.time_ago", :time_in_words => time_ago_in_words(comment.created_at)) %></span></p>
 </div>

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

@@ -2,6 +2,7 @@
   <% 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 comment-submit", :id => "comment_submit_#{parent.dom_id}" %>
+    <%= hidden_field_tag :render_new, render_new -%>
+    <%= f.submit t('muck.comments.add_comment_button'), :class => "button comment-submit", :id => "comment_submit_#{parent.dom_id}" %>
   <% end -%>
 </div>

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

@@ -0,0 +1,3 @@
+<%= output_errors(t('muck.comments.problem_adding_comment'), {:class => 'help-box'}, @comment) %>
+<%= show_comments(@comments) unless @comments.blank? %>
+<%= comment_form(@parent, nil, true) unless @parent.blank? %>

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

@@ -0,0 +1,5 @@
+<div id="add_comment">
+  <h2><%= @page_title %><h2>
+  <%= output_errors(t('muck.comments.problem_adding_comment'), {:class => 'help-box'}, @comment) %>
+  <%= comment_form(@parent, nil, true) %>
+</div>

data/db/migrate/20090730154102_allow_null_user.rb

@@ -0,0 +1,9 @@
+class AllowNullUser < ActiveRecord::Migration
+  def self.up
+    change_column :comments, :user_id, :integer, :null => true, :default => nil
+  end
+
+  def self.down
+    change_column :comments, :user_id, :integer, :null => false, :default => 0
+  end
+end

data/lib/active_record/acts/muck_comment.rb

@@ -12,13 +12,13 @@ module ActiveRecord
           acts_as_nested_set :scope => [:commentable_id, :commentable_type]
           validates_presence_of :body
           belongs_to :user
-          belongs_to :commentable, :polymorphic => true
+          belongs_to :commentable, :counter_cache => 'comment_count', :polymorphic => true
 
           named_scope :by_newest, :order => "created_at DESC"
+          named_scope :by_oldest, :order => "created_at ASC"
           named_scope :recent, lambda { { :conditions => ['created_at > ?', 1.week.ago] } }
                             
           class_eval <<-EOV
-
             # prevents a user from submitting a crafted form that bypasses activation
             attr_protected :created_at, :updated_at
           EOV

data/lib/acts_as_commentable_with_threading.rb

@@ -21,7 +21,7 @@ module Acts #:nodoc:
       def find_comments_for(obj)
         commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
        
-        Comment.find(:all,
+        self.find(:all,
           :conditions => ["commentable_id = ? and commentable_type = ?", obj.id, commentable],
           :order => "created_at DESC"
         )
@@ -33,7 +33,7 @@ module Acts #:nodoc:
       def find_comments_by_user(user) 
         commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
         
-        Comment.find(:all,
+        self.find(:all,
           :conditions => ["user_id = ? and commentable_type = ?", user.id, commentable],
           :order => "created_at DESC"
         )
@@ -50,7 +50,7 @@ module Acts #:nodoc:
       
       # Helper method to sort comments by date
       def comments_ordered_by_submitted
-        Comment.find(:all,
+        self.class.find(:all,
           :conditions => ["commentable_id = ? and commentable_type = ?", id, self.class.name],
           :order => "created_at DESC"
         )

data/lib/muck_comments.rb

@@ -3,3 +3,5 @@ require 'acts_as_commentable_with_threading'
 ActiveRecord::Base.class_eval { include ActiveRecord::Acts::MuckComment }
 ActionController::Base.send :helper, MuckCommentsHelper
 I18n.load_path += Dir[ File.join(File.dirname(__FILE__), '..', 'locales', '*.{rb,yml}') ]
+
+Mime::Type.register "text/javascript", :pjs

data/locales/en.yml

@@ -2,10 +2,14 @@ en:
   muck:
     comments:
       cant_delete_comment: "You don't have permission to delete that comment"
-      missing_parent_id_error: "Please specify a parent object"
       comment_removed: "Comment successfully removed."
       create_error: "Could not create the comment {{errors}}"
+      create_success: "Successfully added comment"
       add_comment: "Comment"
+      add_comment_button: "Add Comment"
       missing_comment_template_error: "Could not find a partial named {{partial}}.  Please create a comment partial and try again."
+      new_comment_no_title: "Add a new comment"
+      new_comment_with_title: "Add a new comment to {{title}}"
+      problem_adding_comment: "There was a problem adding your comment"
     activity_templates:
       comment: Comments