commentem 1.0.0 → 1.0.1

data/Manifest

@@ -1,11 +1,10 @@
-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
+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

data/README.rdoc

@@ -1,112 +1,68 @@
-= 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
+= 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
+
+-----
+
+TODO List:
+
+* Better documentation (Making use of rdoc and ri)
+* Write tests
+
+== 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 example below:
+
+    # 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")
+	@usr.comment(@user, "you could comment on yourself too")
+    
+    # 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

@@ -2,9 +2,9 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('commentem', '1.0.0') do |p|
+Echoe.new('commentem', '1.0.1') do |p|
   p.description     = "A generic commenting system."
-  p.url             = "http://github.com/peterwongpp/commentem"
+  p.url             = "http://github.com/peterwongpp/Commentem"
   p.author          = "Peter Wong"
   p.email           = "peter@peterwongpp.com"
   p.ignore_pattern  = ["tmp/*", "script/*"]

data/commentem.gemspec

@@ -1,30 +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
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{commentem}
+  s.version = "1.0.1"
+
+  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-20}
+  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

metadata

@@ -1,8 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: commentem
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 1.0.0
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Peter Wong
@@ -10,7 +14,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 Z
+date: 2011-05-20 00:00:00 +08:00
+default_executable: 
 dependencies: []
 
 description: A generic commenting system.
@@ -39,7 +44,8 @@ files:
 - lib/generators/templates/migration.rb
 - lib/generators/templates/model.rb
 - commentem.gemspec
-homepage: http://github.com/peterwongpp/commentem
+has_rdoc: true
+homepage: http://github.com/peterwongpp/Commentem
 licenses: []
 
 post_install_message: 
@@ -57,17 +63,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
 requirements: []
 
 rubyforge_project: commentem
-rubygems_version: 1.8.3
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A generic commenting system.