the_comments 0.9.9 → 1.0.0

data/README.md

@@ -1,12 +1,10 @@
 # TheComments 1.0.0
 
-TheComments - just comment system for my Ruby on Rails 4 projects
-
-P.S: and for me it's best prototype of comment system for Rails 4
+TheComments - just comment system for my Ruby on Rails 4 projects. [(rubygems)](http://rubygems.org/gems/the_comments)
 
 ## Keywords
 
-Comments for Rails 4, Comments with threading, Nested Comments, Polymorphic comments, Acts as commentable, Comment functionality, Comments, Threading, Rails 4, Comments with moderation, I hate captcha for comments!
+Comments for Rails 4, Comments with threading, Nested Comments, Polymorphic comments, Acts as commentable, Comment functionality, Comments, Threading, Rails 4, Comments with moderation, I hate captcha!
 
 ## Screenshots
 
@@ -21,11 +19,11 @@ Comments for Rails 4, Comments with threading, Nested Comments, Polymorphic comm
     <td width="20%">Recent comments & Denormalization</td>
   </tr>
   <tr>
-    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_2.gif" alt="the_comments"></td>
-    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_1.gif" alt="the_comments"></td>
-    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_4.gif" alt="the_comments"></td>    
-    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_3.gif" alt="the_comments"></td>    
-    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_5.gif" alt="the_comments"></td>
+    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/the-teacher/the_comments/master/docs/the_comments_view_2.gif" alt="the_comments"></td>
+    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/the-teacher/the_comments/master/docs/the_comments_view_1.gif" alt="the_comments"></td>
+    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/the-teacher/the_comments/master/docs/the_comments_view_4.gif" alt="the_comments"></td>    
+    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/the-teacher/the_comments/master/docs/the_comments_view_3.gif" alt="the_comments"></td>    
+    <td width="20%"><img width="100%" height="100%" src="https://raw.github.com/the-teacher/the_comments/master/docs/the_comments_view_5.gif" alt="the_comments"></td>
   </tr>
 </table>
 
@@ -51,6 +49,8 @@ Comments for Rails 4, Comments with threading, Nested Comments, Polymorphic comm
 * [Commentable methods](#commentable-methods)
 * [Online Support](#online-support)
 * [About author](#about-author)
+* [What about specs?](#what-about-specs)
+
 
 ## Installation
 
@@ -176,20 +176,22 @@ end
 
 ### Any Commentable Model (Page, Blog, Article, User(!) ...)
 
+Read more about **commentable_title**, **commentable_url** and **commentable_state** methods here: [Denormalization and Recent comments](#denormalization)
+
 ```ruby
 class Blog < ActiveRecord::Base
   include TheCommentsCommentable
 
   def commentable_title
-    # by default:  try(:title) || 'Undefined title'
+    # by default: try(:title) || TheComments.config.default_title
     # for example: "My first blog post"
     blog_post_name
   end
 
   def commentable_url
     # by default:  ['', self.class.to_s.tableize, self.to_param].join('/')
-    # for example: "blogs/1-my-first-blog-post"
-    [self.class.to_s.tableize, slug_id].join('/')
+    # for example: "/blogs/1-my-first-blog-post"
+    ['', self.class.to_s.tableize, slug_id].join('/')
   end
 
   def commentable_state
@@ -202,6 +204,7 @@ end
 
 ### Comment Model
 
+
 ```ruby
 class Comment < ActiveRecord::Base
   include TheCommentsBase
@@ -264,7 +267,7 @@ end
 * Spam traps instead Captcha. *I hate Captcha*
 * Blacklists for IP and UserAgent
 * Denormalization for fast and Request-free Recent comments building
-* Ready for external content filters (<b>sanitize</b>, <b>RedCloth</b>, <b>Markdown</b>)
+* Ready for external content filters (<b>sanitize</b>, <b>RedCloth</b>, <b>Markdown</b>, etc)
 * Highlighting and Jumping to comment via anchor
 * Ready for Rails4 (and Rails::Engine)
 * Ready for JQuery 1.9+
@@ -279,7 +282,7 @@ Just look at [Ruby-Toolbox](https://www.ruby-toolbox.com/categories/rails_commen
 * [opinio](https://github.com/Draiken/opinio) - looks better, but there is no threading. I want to have more!
 * [has_threaded_comments](https://github.com/aarongough/has_threaded_comments) - Nice work! Nice gem! Models, controllers, views, view helper for tree rendering! **But**, last activity 2 years ago, I need few features, I think - I can make it better.
 
-![TheComments](https://raw.github.com/open-cook/the_comments/master/docs/the_comments.jpg)
+![TheComments](https://raw.github.com/the-teacher/the_comments/master/docs/the_comments.jpg)
 
 ## Comments, Posted comments, ComComs
 
@@ -344,11 +347,11 @@ Set of All <b>COM</b>ments of All <b>COM</b>mentable objects of this User
 
 For building of Recent comments list (for polymorphic relationship) we need to have many additional requests to database. It's classic problem of polymorphic comments.
 
-I use denormalization of commentable objects for solve of this problem.
+I use denormalization of commentable objects to solve this problem.
 
 My practice shows - We need 3 denormalized fields into comment for (request-free) building of recent comments list:
 
-<img src="https://raw.github.com/open-cook/the_comments/master/docs/the_comments_view_5.gif" alt="the_comments">
+<img src="https://raw.github.com/open-cook/the-teacher/master/docs/the_comments_view_5.gif" alt="the_comments">
 
 * **Comment#commentable_title** - for example: "My first post about Ruby On Rails"
 * **Comment#commentable_url** - for example: "/posts/1-my-first-post-about-ruby-on-rails"
@@ -358,7 +361,7 @@ That is why any **Commentable Model should have few methods** to provide denorma
 
 ## Recent comments building
 
-Denormalization makes, building of Recent comments (for polymorphic relationship) is very easy!
+Denormalization makes building of Recent comments (for polymorphic relationship) very easy!
 
 Controller:
 
@@ -489,9 +492,20 @@ I need your opinion, ideas, user experience - that is why you can ask me about t
 
 Yes, It's true - I was a school teacher in the past.
 That's why my login is the-teacher.
-Now I'm ruby & frontend developer.
+Now I'm ruby/frontend developer and [food-blogger](http://open-cook.ru).
 I learn, I teach, I make a code. And sorry for my English.
 
+## What about specs?
+
+This gem - just first prototype of my ideas about comment system.
+Unfortunatly, I have no time to write many tests for this gem.
+Release 1.0.0 works for my pet projects - it's enough for me.
+If you have a problem with gem and you can to create coverage tests for this problem - I will be happy to get your pull request.
+
+### Where I can find example of application with the_comments?
+
+This gem is part of new version of my food-blog about modern russian home cuisine. There is code of my tasty CMS [open-cook](https://github.com/open-cook/open-cook)
+
 ## Contributing
 
 1. Fork it

data/app/controllers/concerns/the_comments_controller.rb

@@ -70,7 +70,7 @@ module TheCommentsController
     end
 
     def new
-      @comments = current_user.my_comments.with_state(:draft).order('created_at DESC').page(params[:page])
+      @comments = current_user.comcoms.with_state(:draft).order('created_at DESC').page(params[:page])
       render template: 'the_comments/manage'
     end
 

data/app/models/concerns/the_comments_base.rb

@@ -63,7 +63,7 @@ module TheCommentsBase
 
   def update_cache_counters
     user.try        :recalculate_my_comments_counter!
-    commentable.try :increment!, :draft_comments_count
-    holder.try      :increment!, :draft_comcoms_count
+    commentable.try :increment!, "#{state}_comments_count"
+    holder.try      :increment!, "#{state}_comcoms_count"
   end
 end

data/app/models/concerns/the_comments_commentable.rb

@@ -9,7 +9,10 @@ module TheCommentsCommentable
     after_save        :denormalize_for_comments
   end
 
+  # Default Denormalization methods
+  # Overwrite it with your Application
   def commentable_title
+    # My first blog post
     try(:title) || TheComments.config.default_title
   end
 
@@ -23,6 +26,7 @@ module TheCommentsCommentable
     try(:state)
   end
 
+  # Helper methods
   def comments_sum
     published_comments_count + draft_comments_count
   end

data/app/models/concerns/the_comments_states.rb

@@ -42,6 +42,7 @@ module TheCommentsStates
       after_transition [:draft, :published] => :deleted do |comment|
         ids = comment.self_and_descendants.map(&:id)
         Comment.where(id: ids).update_all(state: :deleted)
+
         @owner.try       :recalculate_my_comments_counter!
         @holder.try      :recalculate_comcoms_counters!
         @commentable.try :recalculate_comments_counters!

data/db/migrate/20130101010101_create_comments.rb

@@ -76,7 +76,7 @@ class CreateComments < ActiveRecord::Migration
       t.integer :spam_comcoms_count,      default: 0
     end
 
-    # Uncomment this. Add fields Commentable Models
+    # Uncomment this. Add fields to Commentable Models
     #
     # [:posts, :blogs, :articles, :pages].each do |table_name|
     #   change_table table_name do |t|

data/lib/generators/the_comments/templates/comments_controller.rb

@@ -15,6 +15,7 @@ class CommentsController < ApplicationController
   # Application side methods:
   # Overwrite following default methods if it's need
   # Following methods based on *current_user* helper method
+  # Look here: https://github.com/the-teacher/the_comments/blob/master/app/controllers/concerns/the_comments_controller.rb#L62
   #
   # [:my, :incoming, :edit, :trash]
 

data/lib/generators/the_comments/templates/the_comments.rb

@@ -1,10 +1,10 @@
 # TheComments.config.param_name => value
 
 TheComments.configure do |config|
-  config.max_reply_depth     = 3
-  config.tolerance_time      = 5
-  config.default_state       = :draft
-  config.default_owner_state = :published
-  config.empty_inputs        = [:commentBody]
-  config.default_title       = 'Undefined title'
+  config.max_reply_depth     = 3                   # comments tree depth
+  config.tolerance_time      = 5                   # sec - after this delay user can post a comment
+  config.default_state       = :draft              # default state for comment
+  config.default_owner_state = :published          # default state for comment for Moderator
+  config.empty_inputs        = [:commentBody]      # array of spam trap fields
+  config.default_title       = 'Undefined title'   # default commentable_title for denormalization
 end

data/lib/the_comments/version.rb

@@ -1,3 +1,3 @@
 module TheComments
-  VERSION = "0.9.9"
+  VERSION = "1.0.0"
 end

data/the_comments.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = TheComments::VERSION
   gem.authors       = ["Ilya N. Zykin"]
   gem.email         = ["zykin-ilya@ya.ru"]
-  gem.description   = %q{ Nested Comments }
-  gem.summary       = %q{ Nested Comments form TheTeacher }
+  gem.description   = %q{ Comments with threading for Rails 4 }
+  gem.summary       = %q{ the_comments by the-teacher }
   gem.homepage      = "https://github.com/open-cook/the_comments"
 
   gem.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: the_comments
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machine
-  requirement: &78089010 !ruby/object:Gem::Requirement
+  requirement: &78157620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78089010
+  version_requirements: *78157620
 - !ruby/object:Gem::Dependency
   name: the_sortable_tree
-  requirement: &78088800 !ruby/object:Gem::Requirement
+  requirement: &78157410 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +32,8 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78088800
-description: ! ' Nested Comments '
+  version_requirements: *78157410
+description: ! ' Comments with threading for Rails 4 '
 email:
 - zykin-ilya@ya.ru
 executables: []
@@ -110,5 +110,5 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Nested Comments form TheTeacher
+summary: the_comments by the-teacher
 test_files: []