mm-commentable 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,8 +1,44 @@
-= mm-acts_as_commentable
+= mm-commentable
 
-Description goes here.
+A simple MongoMapper plugin to make adding comments to your models easy
 
-== Contributing to mm-acts_as_commentable
+== Usage
+
+Install the gem
+  
+    gem install mm-commentable
+
+
+Or add it to your Gemfile
+
+    gem 'mm-commentable'
+  
+  
+Then add the commentable plugin to you MongoMapper::Document
+
+    class Post
+      include MongoMapper::Document
+      plugin MongoMapper::Plugins::Commentable
+
+      def on_add_comment(comment)
+        do something when a comment is added...
+      end
+    end
+    
+You must implement the on_add_comment callback! - however it can be an empty implementation
+  
+    @post = Post.create
+    @commentor = User.create
+  
+    @post.add_comment("great post..", @user)
+  
+    @post.comments_count = 1
+    @posts.comments = [<Comment>]
+
+The commentor association is polymorphic, so any class will probably work, but I expect the commentor would normally be a User object
+
+
+== Contributing to mm-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
@@ -12,8 +48,9 @@ Description goes here.
 * 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 (c) 2010 Luke. See LICENSE.txt for
+Copyright (c) 2010 Luke Cunningham. See LICENSE.txt for
 further details.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/mongo_mapper/plugins/commentable/comment.rb

@@ -5,7 +5,8 @@ class Comment
   key :body, String, :required => true
 
   key :commentor_id, ObjectId
-  belongs_to :commentor, :class_name => 'User'
+  key :commentor_type, String
+  belongs_to :commentor, :polymorphic => true
 
   embedded_in :commentable
 end

data/mm-commentable.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mm-commentable}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luke Cunningham"]

data/spec/mm-commentable_spec.rb

@@ -29,6 +29,14 @@ describe "MongoMapper::Plugins::ActsAsCommentable" do
       @commentable.comments.size.should equal 1
     end
     
+    it "should assign the commentor" do
+      @commentable.add_comment!("first comment", @luke)
+      comment = @commentable.comments.first
+      comment.commentor_id.should == @luke.id
+      comment.commentor_type.should == @luke.class.name
+      comment.commentor.should == @luke
+    end
+    
     it "should throw NotImplementedError if the :on_add_vote callback has not inplemented" do
       commentable = CommentableWithoutCallback.new
       lambda {
@@ -67,6 +75,9 @@ describe "Comment" do
   it "should have a commentor association" do
     @comment.should respond_to(:commentor_id=)
     @comment.should respond_to(:commentor_id)
+    @comment.should respond_to(:commentor_type=)
+    @comment.should respond_to(:commentor_type)
+    
     @comment.commentor.association.should be_belongs_to
   end
   

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mm-commentable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Luke Cunningham