Socket
Book a DemoInstallSign in
Socket

acts_as_commentable

Package Overview
Dependencies
Maintainers
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

acts_as_commentable

4.0.2
bundlerRubygems
Version published
Maintainers
4
Created
Source

= Acts As Commentable

Provides a single Comment model that can be attached to any model(s) within your app. It creates a Comment model and handles the plumbing between that model and any models that you declare to be commentable models.

== Installation :

Add the following line to your Gemfile

=== Rails 4

gem 'acts_as_commentable'

=== Rails 3

gem 'acts_as_commentable', '3.0.1'

=== Rails 2

gem 'acts_as_commentable', git: 'git@github.com:jackdempsey/acts_as_commentable.git', branch: '2.x'

== Generator

=== Rails 3+

rails g comment

=== Rails 2

script/generate comment

Then migrate your database to add the comments model:

rake db:migrate

== Usage

Make the desired ActiveRecord model act as commentable:

class Post < ActiveRecord::Base acts_as_commentable end

Add a comment to a model instance by adding the following to the controller:

commentable = Post.create comment = commentable.comments.create comment.title = "First comment." comment.comment = "This is the first comment." comment.save

Fetch comments for the commentable model by adding the following to the view:

commentable = Post.find(1) comments = commentable.comments.recent.limit(10).all

You can also add different types of comments to a model:

class Todo < ActiveRecord::Base acts_as_commentable :public, :private end

Note: This feature is only available from version 4.0 and above

To fetch the different types of comments for this model:

public_comments = Todo.find(1).public_comments private_comments = Todo.find(1).private_comments

By default, acts_as_commentable will assume you are using a Comment model. To change this, or change any other join options, pass in an options hash:

class Todo < ActiveRecord::Base
  acts_as_commentable { class_name: 'MyComment' }
end

This also works in conjunction with comment types:

class Todo < ActiveRecord::Base
  acts_as_commentable :public, :private, { class_name: 'MyComment' }
end

== Credits

Xelipe - This plugin is heavily influenced by Acts As Taggable.

== Contributors

Jack Dempsey, Chris Eppstein, Jim Ray, Matthew Van Horn, Ole Riesenberg, ZhangJinzhu, maddox, monocle, mrzor, Michael Bensoussan

== More

http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/ http://www.juixe.com/projects/acts_as_commentable

FAQs

Package last updated on 02 Oct 2014

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.