ActsAsSnook 技术文档

1. 安装指南

环境要求

• Ruby 版本：确保你的项目使用的是兼容的 Ruby 版本。
• Rails 版本：ActsAsSnook 是一个 Rails 插件，因此需要 Rails 环境。

安装步骤

1. 在你的 Rails 项目根目录下，使用以下命令安装 ActsAsSnook：

   gem install acts_as_snook
   

2. 在 Gemfile 中添加以下内容：

   gem 'acts_as_snook'
   

3. 运行 bundle install 来安装依赖。

4. 在 Rails 项目的 config/application.rb 文件中，确保插件已加载：

   config.plugins = [ :acts_as_snook ]
   

2. 项目的使用说明

基本使用

在需要使用 ActsAsSnook 的模型中，添加以下代码：

class Comment < ApplicationRecord
  acts_as_snook
end

自定义字段

如果你需要自定义字段名称，可以使用以下方式：

class Comment < ApplicationRecord
  acts_as_snook :author_field => :user, :body_field => :comment
end

添加自定义垃圾关键词

你可以通过以下方式添加自定义的垃圾关键词：

class Comment < ApplicationRecord
  acts_as_snook :spam_words => %{hatespeech ignorantlanguage blathering}
end

3. 项目API使用文档

检查评论状态

ActsAsSnook 提供了几个辅助方法来检查评论的状态：

• comment.ham?：返回 true 表示评论不是垃圾评论。
• comment.spam?：返回 true 表示评论是垃圾评论。
• comment.moderate?：返回 true 表示评论需要进一步审核。

快捷查询方法

• Comment#ham：返回所有非垃圾评论。
• Comment#spam：返回所有垃圾评论。
• Comment#moderate：返回所有需要审核的评论。

计数器缓存

如果你在评论的父类中提供了 ham_comments_count 属性，你还可以使用 Entry#ham_comments_count 方法来获取非垃圾评论的数量。

4. 项目安装方式

手动配置

如果你的评论模型有多个 belongs_to 关联，你可以手动配置以下选项：

• :comment_belongs_to：评论所属的父类名称。
• :ham_comments_count_field：父类中用于维护计数器缓存的属性名称。

例如：

class Comment < ApplicationRecord
  acts_as_snook :comment_belongs_to => :entry, :ham_comments_count_field => :ham_comments_count
end

注意事项

• 不要依赖 belongs_to :entry, :counter_cache => true 这样的关联设置来显示评论数量，因为返回的数量是所有评论的总数，而不管垃圾状态。

通过以上步骤，你可以成功安装并使用 ActsAsSnook 插件来处理评论垃圾问题。