jimiray-acts_as_commentable 1.0.0

data/CHANGELOG

@@ -0,0 +1,7 @@
+* revision 8: Changed has_many :dependent => true to :dependent => :destroy for Rails 1.2.2
+                 + Thanks Josh Martin
+              Added an order clause in the has_many relationship.
+              Made comment column type to text from string in migration example in README
+                 + Thanks Patrick Crowley
+              Added this CHANGELOG file.
+              

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,64 @@
+Acts As Commentable
+=================
+
+Allows for comments to be added to multiple and different models.
+
+== Resources
+
+Install
+
+ * To install as a plugin:
+ 
+  script/plugin install http://juixe.com/svn/acts_as_commentable
+ 
+ * To install as a gem:
+ 
+ rake install
+ 
+ * Create a new rails migration and add the following self.up and self.down methods
+ 
+  def self.up
+    create_table "comments", :force => true do |t|
+      t.column "title", :string, :limit => 50, :default => ""
+      t.column "comment", :text, :default => ""
+      t.column "created_at", :datetime, :null => false
+      t.column "commentable_id", :integer, :default => 0, :null => false
+      t.column "commentable_type", :string, :limit => 15, :default => "", :null => false
+      t.column "user_id", :integer, :default => 0, :null => false
+    end
+  
+    add_index "comments", ["user_id"], :name => "fk_comments_user"
+  end
+
+  def self.down
+    drop_table :comments
+  end
+
+== Usage
+ 
+ * Make you ActiveRecord model act as commentable.
+ 
+ class Model < ActiveRecord::Base
+ 	acts_as_commentable
+ end
+ 
+ * Add a comment to a model instance
+ 
+ model = Model.new
+ comment = Comment.new
+ comment.comment = 'Some comment'
+ model.comments << comment
+ 
+ * Each comment reference commentable object
+ 
+ model = Model.find(1)
+ model.comments.get(0).commtable == model
+
+== Credits
+
+Xelipe - This plugin is heavily influced by Acts As Tagglable.
+
+== More
+
+http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/
+http://www.juixe.com/projects/acts_as_commentable

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+PLUGIN = "acts_as_commentable"
+NAME = "acts_as_commentable"
+VERSION = "1.0.0"
+AUTHOR = "Cosmin Radoi"
+EMAIL = "unknown@juixe.com"
+HOMEPAGE = "http://www.juixe.com/techknow/index.php/2006/06/18/acts-as-commentable-plugin/"
+SUMMARY = "Plugin/gem that provides comment functionality"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.5.0')
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(MIT-LICENSE README Rakefile) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end

data/acts_as_commentable.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name     = "acts_as_commentable"
+  s.version  = "1.0.0"
+  s.date     = "2008-10-30"
+  s.summary  = "Polymorphic comments Rails plugin"
+  s.email    = "jimiray@mac.com"
+  s.homepage = "http://github.com/jimiray/acts_as_commentable"
+  s.description = "Polymorphic comments Rails plugin"
+  s.has_rdoc = true
+  s.authors  = ["Jack Dempsey", "Xelipe"] 
+  s.files    = ["CHANGELOG", 
+		"MIT-LICENSE", 
+		"README",
+		"Rakefile", 
+		"acts_as_commentable.gemspec", 
+                "init.rb",
+                "install.rb",
+		"lib/acts_as_commentable.rb", 
+		"lib/comment.rb"]
+  s.test_files = ["test/acts_as_commentable_test.rb"]
+  s.rdoc_options = ["--main", "README"]
+end

data/init.rb

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

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/acts_as_commentable.rb

@@ -0,0 +1,64 @@
+# 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.rb

@@ -0,0 +1,34 @@
+class Comment < ActiveRecord::Base
+  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
+  
+  # Helper class method to lookup all comments assigned
+  # to all commentable types for a given user.
+  def self.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 self.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 self.find_commentable(commentable_str, commentable_id)
+    commentable_str.constantize.find(commentable_id)
+  end
+end

data/test/acts_as_commentable_test.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+
+class ActsAsCommentableTest < Test::Unit::TestCase
+  # Replace this with your real tests.
+  def test_this_plugin
+    flunk
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: jimiray-acts_as_commentable
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jack Dempsey
+- Xelipe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-30 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Polymorphic comments Rails plugin
+email: jimiray@mac.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- MIT-LICENSE
+- README
+- Rakefile
+- acts_as_commentable.gemspec
+- init.rb
+- install.rb
+- lib/acts_as_commentable.rb
+- lib/comment.rb
+has_rdoc: true
+homepage: http://github.com/jimiray/acts_as_commentable
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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: 2
+summary: Polymorphic comments Rails plugin
+test_files: 
+- test/acts_as_commentable_test.rb