acts_as_commentable_with_replies 0.0.1 → 0.0.3

data/README.md

@@ -1,6 +1,14 @@
-# ActsAsCommentableWithReplies
+# Acts As Commentable With Replies
 
-TODO: Write a gem description
+## Please don't use it as of now. Because it's under testing.
+
+Acts As Commentable With Replies is a Ruby Gem specifically written for Rails/ActiveRecord models.
+The main goals of this gem are:
+
+- Allow any model to be commentable.
+- Allow any model to post comment.  In other words, comments do not have to come from a user,
+  they can come from any model (such as a Group or Team).
+- Provide an easy to write/read syntax.
 
 ## Installation
 
@@ -16,9 +24,92 @@ Or install it yourself as:
 
     $ gem install acts_as_commentable_with_replies
 
+
+### Database Migrations & Model Generator
+
+Acts As Commentable With Replies uses a comments table to store all comments.  To
+generate migration, model just use.
+
+    rails generate acts_as_commentable_with_replies:migration
+    rake db:migrate
+
+You will get a performance increase by adding in cached columns to your model's
+tables.  You will have to do this manually through your own migrations.  See the
+caching section of this document for more information.
+
 ## Usage
 
-TODO: Write usage instructions here
+### Commentable Models
+
+    class Post < ActiveRecord::Base
+      acts_as_commentable
+    end
+
+    @post = Post.new(:title => 'my post!')
+    @post.save
+
+    @post.comment(:commenter => @user, :message => 'hello this is my comment!')
+    @post.comments.size # =>  1
+
+You can also use it as a reply system in comments
+
+    @comment = Comment.find(1)
+    @post.comment(:commenter => @user, :message => 'nice!', :parent => @comment)
+
+
+### Commenter Models
+
+    class User < ActiveRecord::Base
+      acts_as_commenter
+    end
+
+    @post = Post.find(1)
+    @user = User.find(1)
+    @user.comment(:commentable => @post, :message => 'Comment posted through Commenter')
+
+
+### Some Useful syntaxes
+
+    # to check whether or not user has posted comment on it
+    @post.commented_by?(@user)
+
+    #or
+    @user.commented_on?(@post)
+
+    # to get the list of root comments, not replies
+    @post.root_comments
+
+
+### Caching
+
+To speed up performance you can add cache columns to your commentable model's table.  These
+columns will automatically be updated after each comment.  For example, if we wanted
+to speed up @post we would use the following migration:
+
+    class AddCachedCommentsToPosts < ActiveRecord::Migration
+      def self.up
+        add_column :posts, :cached_comments_total, :integer, :default => 0
+        add_index  :posts, :cached_comments_total
+      end
+
+      def self.down
+        remove_column :posts, :cached_comments_total
+      end
+    end
+
+
+## TODO
+
+Don't know. Haven't decided yet.
+
+
+## Credits
+* [Ryan T](https://github.com/ryanto) - This gem is heavily influenced from [acts_as_voteable]
+* [Evan David Light](https://github.com/elight) - Because this gem is inspired from [acts_as_commentable_with_threading].
+But [acts_as_commentable_with_threading] only supports user as commenter and there are no shortcuts to create comment.
+
+Thank you guys! Without you I don't know if it was possible or not!
+
 
 ## Contributing
 

data/acts_as_commentable_with_replies.gemspec

@@ -17,7 +17,5 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rails', '~> 3.0'
 
-  gem.add_dependency 'activerecord', '>= 3.0'
-  gem.add_dependency 'activesupport', '~> 3.0'
   gem.add_dependency 'awesome_nested_set', '>= 2.0'
 end

data/lib/acts_as_commentable_with_replies.rb

@@ -1,6 +1,6 @@
 require 'active_record'
 require 'active_support/inflector'
-#require 'acts_as_commentable_with_replies/version'
+require 'awesome_nested_set'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
@@ -9,7 +9,6 @@ module ActsAsCommentableWithReplies
   if defined?(ActiveRecord::Base)
     require 'acts_as_commentable_with_replies/extenders/commentable'
     require 'acts_as_commentable_with_replies/extenders/commenter'
-    #require 'acts_as_commentable_with_replies/comment'
     ActiveRecord::Base.extend ActsAsCommentableWithReplies::Extenders::Commentable
     ActiveRecord::Base.extend ActsAsCommentableWithReplies::Extenders::Commenter
   end

data/lib/acts_as_commentable_with_replies/commentable.rb

@@ -22,7 +22,7 @@ module ActsAsCommentableWithReplies
 
     # voting
     def comment(args = {})
-      return false if args[:commenter].nil? || args[:message].nil?
+      return nil if args[:commenter].nil? || args[:message].nil?
 
       comment = Comment.new(
           :commentable => self,
@@ -33,11 +33,12 @@ module ActsAsCommentableWithReplies
       if comment.save
         update_cached_comments
         comment.move_to_child_of(args[:parent]) if !args[:parent].nil?
-        true
+        comment
       else
-        false
+        nil
       end
     end
+    alias :comment! :comment
 
 
     # caching

data/lib/acts_as_commentable_with_replies/commenter.rb

@@ -14,9 +14,10 @@ module ActsAsCommentableWithReplies
 
     # voting
     def comment(args = {})
-      return false if args[:commentable].nil? || args[:message].nil?
+      return nil if args[:commentable].nil? || args[:message].nil?
       args[:commentable].comment args.merge({:commenter => self})
     end
+    alias :comment! :comment
 
     # results
     def commented_on?(commentable)

data/lib/acts_as_commentable_with_replies/version.rb

@@ -1,3 +1,3 @@
 module ActsAsCommentableWithReplies
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_commentable_with_replies
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Filvo Interactive
@@ -32,40 +32,10 @@ dependencies:
         version: "3.0"
   type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: activerecord
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
-  type: :runtime
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: awesome_nested_set
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,7 +46,7 @@ dependencies:
         - 0
         version: "2.0"
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id002
 description: Acts as Commentable with Replies
 email: 
 - info@filvo.com