commentem 1.0.0

data/Manifest

@@ -0,0 +1,11 @@
+README.rdoc
+Rakefile
+commentem.gemspec
+init.rb
+lib/commentem.rb
+lib/commentem/commentable.rb
+lib/commentem/commenter.rb
+lib/generators/commentem_generator.rb
+lib/generators/templates/migration.rb
+lib/generators/templates/model.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,112 @@
+= Commentem
+
+Rails gem for building a commenting systems by using Active Records.
+
+by Peter Wong <peter@peterwongpp.com>
+
+GitHub Project: http://github.com/peterwongpp/commentem
+
+-----
+
+== Installation
+
+=== Rails 3
+
+If you would like to install it as gem, put this in your Gemfile:
+
+    gem 'commentem'
+
+If you would rather like to install it as plugin, run this command in your console:
+
+    rails plugin install git://github.com/peterwongpp/commentem.git
+
+And then run:
+
+    rake generate commentem
+    rake db:migrate
+
+== Usage
+
+Just add `acts_as_commenter` and `acts_as_commentable` to your models. You could mix them in the same model if you like. See the examples below:
+
+---
+
+    # Case 1
+    # A user can comment on posts
+    
+    class User < ActiveRecord::Base
+      acts_as_commenter
+    end
+    
+    class Post < ActiveRecord::Base
+      acts_as_commentable
+    end
+    
+    # You have to build your own form for commenting
+    # To comment:
+    
+    @user = User.find(1)
+    @post = Post.find(1)
+    
+    @user.comment(@post, "Your comment's here :)")
+    
+    # To read comments:
+    
+    @post = Post.find(1)
+    @post.comments
+
+---
+
+    # Case 2
+    # A user can comment on users
+    
+    class User < ActiveRecord::Base
+      acts_as_commenter
+      acts_as_commentable
+    end
+    
+    # To comment:
+    @user1 = User.find(1) # The user who gives the comment
+    @user2 = User.find(2) # The user who receives the comment
+    
+    @user1.comment(@user2, "comment goes to here")
+    
+    # To read comments:
+    @user = User.fond(2)
+    
+    @user.comments
+
+---
+
+    # Case 3
+    # A user can comment on users or posts
+    
+    class User < ActiveRecord::Base
+      acts_as_commenter
+      acts_as_commentable
+    end
+    
+    class Post < ActiveRecord::Base
+      acts_as_commentable
+    end
+    
+    # To comment
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @post = Post.find(1)
+    
+    @user.comment(@user2, "comment goes to here")
+    @user.comment(@post, "comment goes to here")
+    
+    # To read comments:
+    
+    @user = User.find(1)
+    @user2 = User.find(2)
+    @post = Post.find(1)
+    
+    @user2.comments
+    @post.comments
+    
+    @user.comments # retrieve all comments from @user, including on @user2 and @post
+    @user.comments_on(@user2) # same as @user2.comments
+    @user.comments_on(@post) # same as @post.comments

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('commentem', '1.0.0') do |p|
+  p.description     = "A generic commenting system."
+  p.url             = "http://github.com/peterwongpp/commentem"
+  p.author          = "Peter Wong"
+  p.email           = "peter@peterwongpp.com"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.take"].sort.each { |ext| load ext }

data/commentem.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{commentem}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Peter Wong"]
+  s.date = %q{2011-05-19}
+  s.description = %q{A generic commenting system.}
+  s.email = %q{peter@peterwongpp.com}
+  s.extra_rdoc_files = ["README.rdoc", "lib/commentem.rb", "lib/commentem/commentable.rb", "lib/commentem/commenter.rb", "lib/generators/commentem_generator.rb", "lib/generators/templates/migration.rb", "lib/generators/templates/model.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/commentem.rb", "lib/commentem/commentable.rb", "lib/commentem/commenter.rb", "lib/generators/commentem_generator.rb", "lib/generators/templates/migration.rb", "lib/generators/templates/model.rb", "commentem.gemspec"]
+  s.homepage = %q{http://github.com/peterwongpp/commentem}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Commentem", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{commentem}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A generic commenting system.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'commentem'

data/lib/commentem/commentable.rb

@@ -0,0 +1,20 @@
+module Commentem
+  module Commentable
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_commentable
+        has_many :comments, :as => :commentable, :dependent => :destroy
+        include Commentem::Commentable::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def comments_by(commenter)
+        self.comments.comments_by(commenter)
+      end
+    end
+  end
+end

data/lib/commentem/commenter.rb

@@ -0,0 +1,24 @@
+module Commentem
+  module Commenter
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      def acts_as_commenter
+        has_many :commentings, :as => :commenter, :dependent => :destroy, :class_name => "Comment"
+        include Commentem::Commenter::InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      def comments_on(commentable)
+        self.commentings.comments_on(commentable)
+      end
+      
+      def comment(commentable, content)
+        self.commentings.create(:commentable => commentable, :content => content)
+      end
+    end
+  end
+end

data/lib/commentem.rb

@@ -0,0 +1,5 @@
+require File.dirname(__FILE__) + "/commentem/commenter"
+require File.dirname(__FILE__) + "/commentem/commentable"
+
+ActiveRecord::Base.send(:include, Commentem::Commenter)
+ActiveRecord::Base.send(:include, Commentem::Commentable)

data/lib/generators/commentem_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CommentemGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/commentem_migration.rb'
+  end
+  
+  def create_model
+    template 'model.rb', File.join('app/models', 'comment.rb')
+  end
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,17 @@
+class CommentemMigration < ActiveRecord::Migration
+  def self.up
+    create_table :comments, :force => true do |t|
+      t.references :commenter,    :polymorphic => true, :null => false
+      t.references :commentable,  :polymorphic => true, :null => false
+      t.text  :content
+      t.timestamps
+    end
+    
+    add_index :comments, [:commenter_id, :commenter_type]
+    add_index :comments, [:commentable_id, :commentable_type]
+  end
+  
+  def self.down
+    drop_table :comments
+  end
+end

data/lib/generators/templates/model.rb

@@ -0,0 +1,7 @@
+class Comment < ActiveRecord::Base
+  scope :comments_by, lambda { |commenter| where(["commenter_id = ? AND commenter_type = ?", commenter.id, commenter.class.name]) }
+  scope :comments_on, lambda { |commentable| where(["commentable_id = ? AND commentable_type = ?", commentable.id, commentable.class.name]) }
+  
+  belongs_to :commenter, :polymorphic => true
+  belongs_to :commentable, :polymorphic => true
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: commentem
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Peter Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-19 00:00:00 Z
+dependencies: []
+
+description: A generic commenting system.
+email: peter@peterwongpp.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/commentem.rb
+- lib/commentem/commentable.rb
+- lib/commentem/commenter.rb
+- lib/generators/commentem_generator.rb
+- lib/generators/templates/migration.rb
+- lib/generators/templates/model.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/commentem.rb
+- lib/commentem/commentable.rb
+- lib/commentem/commenter.rb
+- lib/generators/commentem_generator.rb
+- lib/generators/templates/migration.rb
+- lib/generators/templates/model.rb
+- commentem.gemspec
+homepage: http://github.com/peterwongpp/commentem
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Commentem
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+requirements: []
+
+rubyforge_project: commentem
+rubygems_version: 1.8.3
+signing_key: 
+specification_version: 3
+summary: A generic commenting system.
+test_files: []
+