Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Provides methods to create commentable Mongoid models
Ruby
tag: v0.0.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
lib
spec
.document
.gitignore
.rspec
Gemfile
Gemfile.lock
LICENSE.txt
README.rdoc
Rakefile
VERSION
mongoid_commentable.gemspec

README.rdoc

mongoid_commentable

Mongoid_commentable provides methods to create commentable documents

Installation

You can use latest gem:

gem install mongoid_commentable

or in Gemfile:

gem 'mongoid_commentable'

Usage

To make model commentable you need to include Mongoid::Commentable into your document:

class Article
  include Mongoid::Document
  include Mongoid::Commentable

  field author
  field content
end

Then you need to set up a nested resource in your routes.rb:

resources :articles do
  resources :comments
end

And in your view file:

<%= link_to "Leave a comment", new_article_comment_path(:article_id => @article.id.to_s) %>

For a reply link add parent comment id:

<%= link_to "Reply", new_article_comment_path(:article_id => @article.id.to_s, :parent => comment.id.to_s) %>

If you want to make a custom views for a comments, run:

rails g mongoid_commentable:views

To get a list of all comments, use following method:

@article.comments_list

it will return comments in ascending order. To get comments in descending order use:

@article.comments_list(:sort => :desc)

NOTE: For descending ordered comments you need to add index to your model manually:

index [['comments', MONGO::DESCENDING]]

To get branch for a comment, use following method:

@article.branch_for(parent_comment_id)

it will return whole branch with all childrens for a certain comment

To get comment level, use following method:

comment.level

To mark comment as deleted, use following method:

@article.mark_comment_deleted(comment_id)

To get comments count, use:

@article.comments_count

Contributing to mongoid_commentable

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

  • Fork the project

  • Start a feature/bugfix branch

  • Commit and push until you are happy with your contribution

  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.

  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright © 2011 Max Golovnia. See LICENSE.txt for further details.

Something went wrong with that request. Please try again.