Acts As Commentable Plugin

I am happy to announce that I have released the acts_as_commentable plugin, my first Ruby on Rails plugin. The Acts As Commentable plugin allows for comments to be added to your Rails ActiveRecord classes.

To install the Acts As Commentable plugin run the following command:

script/plugin install http://juixe.com/svn/acts_as_commentable

The installation process will add several ruby scripts in the vendor/plugins directory. Create a new rails migration and cut and past the following self.up and self.down methods:

def self.up
  create_table :comments, :force => true do |t|
    t.column :title, :string, :limit => 50, :default => ""
    t.column :comment, :string, :default => ""
    t.column :created_at, :datetime, :null => false
    t.column :commentable_id, :integer, :default => 0, :null => false
    t.column :commentable_type, :string, :limit => 15,
      :default => "", :null => false
    t.column :user_id, :integer, :default => 0, :null => false
  end

  add_index :comments, ["user_id"], :name => "fk_comments_user"
end

def self.down
  drop_table :comments
end

Once you have installed the plugin you can start using it in your ActiveRecord class simply by calling the acts_as_commentable method.

class Post < ActiveRecord::Base
  acts_as_commentable
end

To add a comment to a post object you can do the following:

comment = Comment.new(:title => titleStr, :comment => commentStr)
logger << "COMMENT #{comment.comment}\n"
post.comments << comment

Or you could have use the add_comment method on post.

post.add_comment comment

You can also use the post’s comments property to read all comments for the given post. Once a comment has been added to a post you can always reference the post object using the comment’s commentable property.

comment.commentable # references the post

One note, the default implementation of Acts As Commentable requires you to use a user model to link all comments to a user. This requirement can easily be removed or enhanced in the Comment class. But if you have a user model you can retrieve all comments for a user by executing the following statement:

comments = Comment.find_comments_by_user(userInstance)

If you want to retrieve only the comments for a user for a particular model you can do something like:

postComments = Post.find_comments_by_user(userInstance)

If you have any comments, questions, and/or suggestions please don’t hesitate to drop me a line.

Related posts:

  1. Comments on Acts As Commentable
  2. Acts As Voteable Rails Plugin
  3. Acts As Bookmarkable Plugin
  4. Acts As Rateable Plugin
  5. Acts As Versioned Plugin
  6. Updating A Rails Plugin


50 Responses to “Acts As Commentable Plugin”

  • Bryan Says:

    Just thought you might want to know: we’re using this on likebetter.com for photo commenting. thanks!

  • famoseagle Says:

    I think something happened to this plugin with the newest version of rails. Basically, every time I reload the comment model it’s not picking up the belongs_to relationship. So:

    belongs_to :user

    Causes an ActiveRecord::AssociationTypeMismatch error. Says:

    User expected, got User

    That doesn’t make much sense. I know it’s probably a rails issue, but I thought you might have some insight. There are some other loading issues that are a bit too complex to explain in this little form.

  • TechKnow Says:

    @Bryan
    Did I see you give a presentation on likebetter at the January SV RoR meeting here in the Yay Area!? I was there! Thats a great application you have there…

    @famoseagle
    I think the issue that you are dealing with is that you don’t have a user model. The plugin comes with a comment model and this requires a user. If you don’t have users just feel free to comment the belongs_to :user line in the comment.rb file.

    I did test this with Rails 1.2.2 on two separate machines and ‘it is working on my machine…’ :)

  • carlivar Says:

    How can I do counter caching with acts_as_commentable? Not sure how that works with polymorphic relationships. Currently I am summarizing comment counts quite often which is leading to a lot of extra db queries. Thanks!

  • bmctigue Says:

    Just wanted to let you know that I was getting feedback from my users that comment text was being cutting off. I changed the comment field to be type text and the issue is fixed. Otherwise, a great plugin. Thanks!

  • TechKnow Says:

    @carlivar – You can have a summary table for you model which might have a count of the comment for that model. The summary table is not part of the plugin, so at this time you would need to manage that…

    @bmctigue – The migration in the README used to have comment as a string type this has been modified to describe the comment as a text for a while now. Sorry for any inconvenience that might have caused.

  • carlivar Says:

    Thank you. Small feature request? It would be nice to be able to turn built-in rails counter caching on? Something like:

    acts_as_commentable, :counter_cache => true

  • Anand Says:

    Hi

    Many thanks for this neat plugin. I needed comments on comments [multi level].

    I changed Comment itself to be acts_as_commentable and it works just fine. Do you see any problems with this approach?

    anand

  • matthibcn Says:

    I do get => undefined method ‘find_commentable’ for Comment:Class following this example from Comments on Acts as Commentable found via SWik.

    In my model.rb I do have added acts_as_commentable, also the values commentable / commentable_id are set and post correctly reflecting the model in question…

  • matthibcn Says:

    Never mind, in my enthusiasm I added an CommentModel to my app before reading further yesterday night and then forgot about it at all..so it was overwriting the plugins modelClass..it works as promised ;)

    Thx and regards

  • matthibcn Says:

    Ok, now I do have an issue.

    Where do you get the property “comments” from for a given model ??

    reading on this page and the forumentry I posted above I understand I would get all comments belonging to an ég. item just by doing:

    @comments = @item.comments

    This method isnt veen executed looking at the logfile, nor I dont see any method in your plugin called “comments” so I just wonder where it should come from

    on the other side, I also dont get a “method not found “exception” what makes me wonder also

  • Jan Says:

    @famoseagle: I was thrown back by the same bug as you today and I think I found the problem: Since plugin code doesn’t get reloaded on every request, the comment model saves the object type of the user model at “load time”, but the user model gets reloaded at every request (at least in development mode) and so the user model gets a new object_id every time and this is not reflected in the comments model association.

    The error message is funny, but User and User are really two different things, then. One solution is to move comment.rb to app/models/, since then it will be reloaded, too and all is synchronized.

    A more complete description can be found at

    http://localhost3000.de/2007/04/17/acts_as_commentable-reload-fubar/

    Hope it helps.

  • Casey Helbling Says:

    Jan,
    Thank you very much. That is exactly what I did … Stripped out all the extra garbage and moved it into my app. Very interesting issue though… I will have to keep that one in my back pocket. Thanks for the heads up.
    Casey

  • Mark Says:

    After upgrading to rails 1.2.3 I am occasionally getting the following error when accessing the comments for a model that acts_as_commentable.

    undefined method `table_name’ for REXML::Comment:Class

    It appears that the wrong Comment class is being referenced. Has anybody else seen this? Does anybody know how to fix it?

    Thanks,
    Mark

  • herval Says:

    My dirty little hack to use counter_cache while you guys don’t come up with a new release:

    http://www.hervalfreire.com/blog/2007/05/13/caching-comments-with-acts_as_commentable/

  • Avi Says:

    I sexy’d up that migration for Rails 2.0 or the Sexy_Migration plugin:

    def self.up
      create_table :comments, :force => true do
        string :title, :limit => 50, :default => ""
        string :comment, :default => ""
        timestamps!
        polymorphic :commentable
        foreign_key :user
      end
    
      add_index :comments, ["user_id"], :name => "fk_comments_user"
    end
    
    def self.down
      drop_table :comments
    end
    
  • Trazando ideas » Blog Archive » Rails plugins (1): Acts as Commentable. Comentarios para modelos en Rails Says:

    [...] primero es Acts as Commentable que, cómo indica su nombre, permite marcar los modelos Rails como comentables. No hay nada más [...]

  • Lance Carlson Says:

    Hey I love the plugin. Was just wondering if you or I could make a generator for the migrations and stick them inside the repo. I think it will make the installation just that much easier :)

  • Andrew Gordon Says:

    Great plugin thanks

  • Andrew Gordon Says:

    [new to rails] and being stupid, but how do i get the name of the user who added the comment, i have a partial that displays the comment and thought i would enter somthing like but this dont work.

    I am using acts_as_authenticated, can anyone help me?

  • Evan Says:

    Andrew -

    You should be able to make use of the model associations (ie, has_many: , belongs_to:, etc) to pull in the name of the user from another table. An example:

    ” class=”comment_bar”>
    ” class=”comment_header”> ()
    ” class=”comment_body”>

  • Evan Says:

    Hmm. The cut and paste didn’t translate well.

    Lets say that I have a photo model using acts_as_commentable, which is associated to the user model with belongs_to: / has_many:

    I would do something to this effect in the view:

    for p in @photo.comments
    … p.user.realname
    … p.user.email

    (etc)

  • hedgehog lab blog → Blog Archive » Acts as Taskable plugin Says:

    [...] certainly benefited from plugins in our Rails development, using some really useful plugins like acts_as_commentable, attachment_fu and [...]

  • Food for thought : Useful URLs for RoR 2.0 Says:

    [...] acts_as_commentable plugin [...]

  • Soleone Says:

    Very good plugin, because it’s easy to install and use, and also easy to change since it’s so small.

    Note: The sexy migration (Rails 2.0 style) posted here does not work and needs some changes first.

  • morgajel Says:

    Nice plugin, I plan on using it for a project I’m working on. One thing you could add with little effort is a fixture. acts_as_taggable_on_steroids has a good example- it’d be like 1 line in your test file and yaml file with some default data.

    either way, nice job, keep up the good work.

  • Jason Says:

    Awesome plugin! If you’d like to map the comments table to a non-standard user foreign key but aren’t sure where to start, I wrote up a short blog post about it: Using acts_as_commentable with a non-standard user foreign key

    Hope this helps somebody!

  • Vipin Says:

    Hey guys,
    Is there any way to integrate attachment_fu plugin with in Acts As Commentable Plugin? i want to add more than 1 image for a comment. how can i do it?
    thanks in advance
    Vipin

  • Ivan Storck Says:

    This is the migration I used for Rails 2.0 (mostly sexy migrations)

      def self.up
        create_table :comments, :force => true do |t|
          t.string :title, :default => ""
          t.text :comment, :default => ""
          t.timestamps
          t.integer :user_id, :default => 0, :null => false
          t.string :web_site
          t.string :email
          t.string :name
          t.references :commentable, :polymorphic => true
        end
        add_index :comments, ["user_id"], :name => "fk_comments_user"
      end
    
  • Skribit Reloaded « Rob’s Blog - Technology, Atlanta, Startups and Stuff Says:

    [...] my contribution (with gratitude to acts_as_commentable) – you can now comment on a suggestion.  Because the meaning of a suggestion isn’t always [...]

  • acts_as_commentable for noobs (like me) Says:

    [...] was working on adding a commenting system to the site and all my web searches pointed to the acts_as_commentable Rails plugin. Now since I’m a noob, I didn’t understand how to use most of it, but I finally pieced [...]

  • BrewSession Blog » belong_to RSpec matcher Says:

    [...] was extending acts_as_commentable and needed a good RSpec test to check the returned objects from its finder methods belonged to the [...]

  • BrewSession Blog » Extending acts_as_commentable Says:

    [...] acts_as_commentable is a nice little plugin. It extends your AR classes giving them comments. We are going to use comments on all kinds of things, starting with recipes, of course. However, AAC lacks a critical feature: the ability for users to approve comments before they are displayed. In this post I am going to run through extending AAC using acts_as_state_machine. [...]

  • Randy Says:

    Is there a way to incorporate this with paperclip?

    I added has_attached_file to the comment.rb and followed directions but its not saving the file. It keeps coming up blank.

  • MissingMethod » Archives » How To Build a Social Network with Ruby on Rails Says:

    [...] acts_as_commentable for comments on your user profiles and blog posts [...]

  • hervalicio.us » Blog Archive » Cacheando comentários com acts_as_commentable Says:

    [...] os criadores do acts_as_commentable não lançam uma nova versão do plugin com suporte a counter_caches, aqui vai um pequeno truque [...]

  • VenkelSC Says:

    [...] ruby script/plugin install http://svn.techno-weenie.net/projects/plugins/white_list/ * Sistema de comentarios: Acts_as_commentable [...]

  • Keith Carter Says:

    Is there a way to eager load the objects associated with comments?

  • Alexey Says:

    2 years of superior plugin ! :)

  • Alexey Says:

    I just remember year ago i put this plugin in rails 1.2.6 .. now in 2.1.2 :)

  • Getting Close Says:

    [...] the acts_as_commentable plugin to the newest version. This allows me to streamline the code and add times to the [...]

  • Fran Says:

    Herval’s dirty little hack to use counter_cache (site is down):

    #comments.rb
    
    def after_create
     if commentable.attributes['comments_count']
      commentable.increment!(”comments_count”)
     end
    end
    
    def before_destroy
     if commentable.attributes['comments_count']
      commentable.class.decrement_counter(”comments_count”, commentable.id)
     end
    end
    
  • AJAX with acts_as_commentable — sideline Says:

    [...] had fun this weekend with AJAX-ifying an implementation of the acts_as_commentable plugin. After reading (and implementing) Dave Naffis’ article on adding AJAX to the [...]

  • Auraelius Says:

    Hi,
    I’m having trouble when using acts_as_commentable with restful_authentication: The user_id field in the comment table is never getting set — all the values are NULL.

    I have a “users” table as supplied by that plugin. Is acts_as_commentable looking for a “user” table? I’m still trying to understand all of Rails’ pluralization.

    Where in the code does the user_id get set? I’m stepping through the process with a debugger and can’t see it happening. Is this something ActiveRecord does?

    Thanks for helping a newbie figure things out!

  • Jeff Tucker Says:

    Thanks for the plugin! One issue I had when installing though — I grabbed the gem from your most recent commit (19 May 2009) and had the error:

    Expects acts_as_commentable.rb to define ActsAsCommentable (LoadError).
    

    I had to add

    require 'comment_methods'
    

    to the top of lib/acts_as_commentable.rb to get everything running.

  • TechKnow Says:

    @Jeff – Thanks for that info, I test this on a more recent Rails version. I can’t believe it, but this plugin was originally written in Rails 1.2 and now there is talk of Rails 3.0.

  • Rahil Sondhi Says:

    Wow, thank you! More than four years later, your plugin still works. I’m using Rails 3.0.0 and Ruby 1.9.2.

  • Data structures are complicated! [schema for storing gaming team match results] | Tom Russell – A Ruby/Rails Developer Says:

    [...] matches between themselves and other teams. These should be commentable (i thought about using acts_as_commentable, but that doesn’t provide admin management of comments, anonymous commenting, or a captcha [...]

  • J Says:

    It works for me in Rails 3.0.5 and Ruby 1.9.2, but it’s a little bit annoying that I need to specify the user_id manually in the comment object:

    comment = Comment.new(:title => ‘t’, :comment => ‘c’, :user_id => 1)
    post.comments << comment

    if the post object has an user_id property why not using it? maybe through the add_comment method:

    def add_comment(comment)
    comment.user_id = user_id
    comments << comment
    end

    I don't if I'm the only one having this problem. do I?

Leave a Reply