jackdempsey-acts_as_commentable 2.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Cosmin Radoi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,63 @@
+Acts As Commentable
+=================
+
+Allows for comments to be added to multiple and different models.
+
+== Resources
+
+Install
+
+  Rails
+
+   * To install as a plugin:
+ 
+    script/plugin install http://github.com/jackdempsey/acts_as_commentable.git
+
+  Merb/Rails
+  
+   * To install as a gem:
+ 
+   rake install
+ 
+ Generate your comment model:
+ 
+ script/generate comment
+ 
+ Then migrate your database:
+ 
+ rake db:migrate
+
+== Usage
+ Merb Users:
+ * add 'dependency "acts_as_commentable"' to your init.rb or dependencies.rb if using merb-stack
+ 
+ * Make your ActiveRecord model act as commentable.
+ 
+ class Model < ActiveRecord::Base
+ 	acts_as_commentable
+ end
+ 
+ * Add a comment to a model instance
+ 
+ commentable = Model.create
+ commentable.comments.create(:title => "First comment.", :comment => "This is the first comment.")
+
+ * Fetch comments for a commentable model:
+ 
+ commentable = Model.find(1)
+ comments = commentable.comments.recent.limit(10).all
+
+ # Following doesn't work/make sense to me. Leaving for historical sake -- Jack
+ # * Each comment reference commentable object
+ #
+ # model = Model.find(1)
+ # model.comments.get(0).commentable == model
+
+== Credits
+
+Xelipe - This plugin is heavily influenced by Acts As Taggable.
+
+== More
+
+http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
+http://www.juixe.com/projects/acts_as_commentable

data/generators/comment/comment_generator.rb

@@ -0,0 +1,13 @@
+class CommentGenerator < Rails::Generator::Base
+   def manifest
+     record do |m|
+       m.directory 'app/models'
+       m.file 'comment.rb', 'app/models/comment.rb'
+       m.migration_template "create_comments.rb", "db/migrate"
+     end
+   end
+   # ick what a hack.
+   def file_name
+     "create_comments"
+   end
+ end

data/generators/comment/templates/comment.rb

@@ -0,0 +1,14 @@
+class Comment < ActiveRecord::Base
+
+  include ActsAsCommentable::Comment
+
+  belongs_to :commentable, :polymorphic => true
+
+  # NOTE: install the acts_as_votable plugin if you
+  # want user to vote on the quality of comments.
+  #acts_as_voteable
+
+  # NOTE: Comments belong to a user
+  belongs_to :user
+
+end

data/generators/comment/templates/create_comments.rb

@@ -0,0 +1,19 @@
+class CreateComments < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.string :title, :limit => 50, :default => "" 
+      t.text :comment, :default => "" 
+      t.references :commentable, :polymorphic => true
+      t.references :user
+      t.timestamps
+    end
+
+    add_index :comments, :commentable_type
+    add_index :comments, :commentable_id
+    add_index :comments, :user_id
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/init.rb

@@ -0,0 +1,4 @@
+# Include hook code here
+require 'acts_as_commentable'
+require 'comment_methods'
+

data/install.rb

@@ -0,0 +1,2 @@
+puts "To create the comment model please run:"
+puts "script/generate comment"

data/lib/acts_as_commentable.rb

@@ -0,0 +1,66 @@
+require 'activerecord'
+
+# ActsAsCommentable
+module Juixe
+  module Acts #:nodoc:
+    module Commentable #:nodoc:
+
+      def self.included(base)
+        base.extend ClassMethods  
+      end
+
+      module ClassMethods
+        def acts_as_commentable
+          has_many :comments, :as => :commentable, :dependent => :destroy, :order => 'created_at ASC'
+          include Juixe::Acts::Commentable::InstanceMethods
+          extend Juixe::Acts::Commentable::SingletonMethods
+        end
+      end
+      
+      # This module contains class methods
+      module SingletonMethods
+        # Helper method to lookup for comments for a given object.
+        # This method is equivalent to obj.comments.
+        def find_comments_for(obj)
+          commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+         
+          Comment.find(:all,
+            :conditions => ["commentable_id = ? and commentable_type = ?", obj.id, commentable],
+            :order => "created_at DESC"
+          )
+        end
+        
+        # Helper class method to lookup comments for
+        # the mixin commentable type written by a given user.  
+        # This method is NOT equivalent to Comment.find_comments_for_user
+        def find_comments_by_user(user) 
+          commentable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
+          
+          Comment.find(:all,
+            :conditions => ["user_id = ? and commentable_type = ?", user.id, commentable],
+            :order => "created_at DESC"
+          )
+        end
+      end
+      
+      # This module contains instance methods
+      module InstanceMethods
+        # Helper method to sort comments by date
+        def comments_ordered_by_submitted
+          Comment.find(:all,
+            :conditions => ["commentable_id = ? and commentable_type = ?", id, self.type.name],
+            :order => "created_at DESC"
+          )
+        end
+        
+        # Helper method that defaults the submitted time.
+        def add_comment(comment)
+          comments << comment
+        end
+      end
+      
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Juixe::Acts::Commentable)

data/lib/comment_methods.rb

@@ -0,0 +1,43 @@
+module ActsAsCommentable
+  # including this module into your Comment model will give you finders and named scopes
+  # useful for working with Comments.
+  # The named scopes are:
+  #   in_order: Returns comments in the order they were created (created_at ASC).
+  #   recent: Returns comments by how recently they were created (created_at DESC).
+  #   limit(N): Return no more than N comments.
+  module Comment
+    
+    def self.included(comment_model)
+      comment_model.extend Finders
+      comment_model.named_scope :in_order, {:order => 'created_at ASC'}
+      comment_model.named_scope :recent, {:order => "created_at DESC"}
+      comment_model.named_scope :limit, lambda {|limit| {:limit => limit}}
+    end
+    
+    module Finders
+      # Helper class method to lookup all comments assigned
+      # to all commentable types for a given user.
+      def find_comments_by_user(user)
+        find(:all,
+          :conditions => ["user_id = ?", user.id],
+          :order => "created_at DESC"
+        )
+      end
+
+      # Helper class method to look up all comments for 
+      # commentable class name and commentable id.
+      def find_comments_for_commentable(commentable_str, commentable_id)
+        find(:all,
+          :conditions => ["commentable_type = ? and commentable_id = ?", commentable_str, commentable_id],
+          :order => "created_at DESC"
+        )
+      end
+
+      # Helper class method to look up a commentable object
+      # given the commentable class name and id 
+      def find_commentable(commentable_str, commentable_id)
+        commentable_str.constantize.find(commentable_id)
+      end
+    end
+  end
+end

data/tasks/acts_as_commentable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_commentable do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: jackdempsey-acts_as_commentable
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Cosmin Radoi, Jack Dempsey, Xelipe, Chris Eppstein
+autorequire: acts_as_commentable
+bindir: bin
+cert_chain: []
+
+date: 2009-05-22 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Plugin/gem that provides comment functionality
+email: unknown@juixe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README
+- generators/comment
+- generators/comment/comment_generator.rb
+- generators/comment/templates
+- generators/comment/templates/comment.rb
+- generators/comment/templates/create_comments.rb
+- lib/acts_as_commentable.rb
+- lib/comment_methods.rb
+- tasks/acts_as_commentable_tasks.rake
+- init.rb
+- install.rb
+has_rdoc: false
+homepage: http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Plugin/gem that provides comment functionality
+test_files: []
+