Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
updated rdoc
  • Loading branch information
Russell Norris committed Dec 29, 2008
1 parent 9581f99 commit 964b572
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.rdoc
Expand Up @@ -11,7 +11,7 @@ ActsAsSnook can also be configured to maintain a counter cache of ham comments [
* <tt>:comment_belongs_to</tt> - The name of the parent class that comments belong to.
* <tt>:ham_comments_count_field</tt> - The name of the attribute on the parent class which maintains the counter cache.

<strong>Note:</strong> Do not rely on an association setup like <tt>belongs_to :entry, :counter_cache => true</tt> for displaying comment count. The number returned there is the number of total comments, irrespective of spam status.
<b>Note:</b> Do not rely on an association setup like <tt>belongs_to :entry, :counter_cache => true</tt> for displaying comment count. The number returned there is the number of total comments, irrespective of spam status.

== Usage

Expand All @@ -27,17 +27,17 @@ You may also add your own keywords to the list of spam keywords that ActsAsSnook

ActsAsSnook also provides some helper methods for determining the spam status of a comment.

<tt>comment.ham?</tt>:: Returns true for comments not marked as spam. "Ham" comments are safe for displaying on your site as is. This is the method you should most likely be using to check an individual comment.
<tt>comment.spam?</tt>:: Returns true for comments marked as spam. These are should not be shown on your site.
<tt>comment.moderate?</tt>:: Returns true for comments that were not marked as actual spam but did not get enough points to be marked as "ham" either. The spam_status field for these will contain "moderate".
<tt>Comment#ham</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "ham"})</tt>
<tt>Comment#spam</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "spam"})</tt>
<tt>Comment#moderate</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "moderate"})</tt>
* <tt>comment.ham?</tt>:: Returns true for comments not marked as spam. "Ham" comments are safe for displaying on your site as is. This is the method you should most likely be using to check an individual comment.
* <tt>comment.spam?</tt>:: Returns true for comments marked as spam. These are should not be shown on your site.
* <tt>comment.moderate?</tt>:: Returns true for comments that were not marked as actual spam but did not get enough points to be marked as "ham" either. The spam_status field for these will contain "moderate".
* <tt>Comment#ham</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "ham"})</tt>
* <tt>Comment#spam</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "spam"})</tt>
* <tt>Comment#moderate</tt>:: Shortcut for <tt>Comment#find(:all, :conditions => {:spam_status => "moderate"})</tt>

If you have provided a <tt>ham_comments_count</tt> attribute on your comment's parent class (in this case, Entry) you also get <tt>Entry#ham_comments_count</tt>. See the documentation for the <tt>acts_as_snook</tt> method for more information on that.

== Credits and Thanks

Much love to Jonathan Snook, web developer extraordinaire. Most of the algorithms of ActsAsSnook [as well as the name, obviously] come from his blog post which you can find here[http://snook.ca/archives/other/effective_blog_comment_spam_blocker] The actual implementation I myself wrote.
Much love to Jonathan Snook, web developer extraordinaire. Most of the ideas/algorithms of ActsAsSnook [as well as the name, obviously] come from his blog post which you can find here[http://snook.ca/archives/other/effective_blog_comment_spam_blocker] The actual Ruby implementation I myself wrote.

Copyright (c) 2008 Lucky Sneaks, released under the MIT license

0 comments on commit 964b572

Please sign in to comment.