Giter VIP home page Giter VIP logo

acts_as_commentable_with_threading's Introduction

Acts As Commentable (now with comment threads(TM)!!! -- kidding on the (TM))

Allows for threaded comments to be added to multiple and different models. Drop-in compatible for acts_as_commentable (however requiring a database schema change)

Requirements

This gem is for Rails 3 and later versions only.

This gem depends on CollectiveIdea's Awesome Nested Set gem. It is installed if not already present when you install this gem.

You can find the gem on GitHub at collectiveidea/awesome_nested_set

Install

In your Gemfile, add:

gem 'acts_as_commentable_with_threading'

and run bundle install.

Migrations

  • To install from scratch:

      rails generate acts_as_commentable_with_threading_migration
    

    This will generate the migration script necessary for the table

  • To upgrade to acts_as_commentable_with_threading from the old acts_as_commentable:

      rails generate acts_as_commentable_upgrade_migration
    

    This will generate the necessary migration to upgrade your comments table to work with acts_as_commentable_with_threading

If the generators fail, you can just as easily create the migrations by hand. See the templates in the generators under lib/generators.

Usage

class Article < ActiveRecord::Base
  acts_as_commentable
end
  • Add a comment to a model instance, for example an Article:

      @article = Article.find(params[:id])
      @user_who_commented = @current_user
      @comment = Comment.build_from( @article, @user_who_commented.id, "Hey guys this is my comment!" )
    
  • To make a newly created comment into a child/reply of another comment:

      comment.move_to_child_of(the_desired_parent_comment)
    
  • To retrieve all comments for an article, including child comments:

      @all_comments = @article.comment_threads
    
  • To retrieve only the root comments without their child comments:

      @root_comments = @article.root_comments
    
  • To check if a comment has children:

      @comment.has_children?
    
  • To verify the number of children a comment has:

      @comment.children.size
    
  • To retrieve a comment's children:

      @comment.children
    
  • If you plan to use the acts_as_voteable plugin with your comment system be sure to uncomment two things:

Credits

And in turn...

  • Xelipe - Because acts_as_commentable was heavily influenced by Acts As Taggable.

More

acts_as_commentable_with_threading's People

Contributors

arjun810 avatar casen avatar christianpeters avatar dfischer avatar jrunning avatar kamarcum avatar tcocca avatar

Stargazers

 avatar

Watchers

 avatar  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.