Git Product home page Git Product logo

mongoid_commentable's Introduction

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'

Then install required model and views:

rails generate mongoid_commentable:install

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) %>

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

@article.comments_list

Example:

<% @article.comments_list.each do |comment| %>
  <p> <%= comment.author %> </p>
  <p> <%= comment.text %> </p> 
<% end %>

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.comments.find(comment_id).remove

To restore comment, use method restore:

@article.comments.find(comment_id).restore

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 © 2011 Max Golovnia. See LICENSE.txt for further details.

mongoid_commentable's People

Contributors

mgolovnia avatar brucexlin avatar danielgatis avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.