The Profanity Filter for Rails 技术文档

1. 安装指南

安装此插件非常简单，只需在项目Gemfile文件中添加以下代码：

gem 'profanity_filter'

然后执行以下命令进行安装：

bundle install

或者，你也可以使用以下命令直接从GitHub安装插件：

./script/plugin install git://github.com/intridea/profanity_filter.git

2. 项目使用说明

此插件可以在Rails项目中过滤不当言论，支持基本的替换或使用词典进行替换。

在模型中使用此过滤器：

• 非破坏性过滤（在调用时过滤内容，原始文本保留在数据库中）：

  profanity_filter :foo, :bar
  #=> 被禁词汇会被替换为 @#=>$%
  
  profanity_filter :foo, :bar, :method => 'dictionary'
  #=> 被禁词汇会被 config/dictionary.yml 文件中的值替换
  
  profanity_filter :foo, :bar, :method => 'vowels'
  #=> 被禁词汇的元音会被替换
  
  profanity_filter :foo, :bar, :method => 'hollow'
  #=> 除了首尾字母之外的所有字母都会被替换
  
  profanity_filter :foo, :bar, :method => 'stars'
  #=> 所有字母都会被替换为 *
  

  非破坏性过滤器为过滤属性提供不同版本的输出：

  some_model.foo => 'filtered version'
  some_model.foo_original => 'non-filtered version'
  

• 破坏性过滤（将过滤后的内容保存到数据库中）：

  profanity_filter! :foo, :bar
  #=> 被禁词汇会被替换为 @#=>$%
  
  profanity_filter! :foo, :bar, :method => 'dictionary'
  #=> 被禁词汇会被 config/dictionary.yml 文件中的值替换
  
  profanity_filter! :foo, :bar, :method => 'vowels'
  #=> 被禁词汇的元音会被替换
  
  profanity_filter! :foo, :bar, :method => 'hollow'
  #=> 除了首尾字母之外的所有字母都会被替换
  
  profanity_filter! :foo, :bar, :method => 'stars'
  #=> 所有字母都会被替换为 *
  

你也可以直接使用过滤器：

ProfanityFilter::Base.clean(text)
ProfanityFilter::Base.clean(text, 'dictionary')
ProfanityFilter::Base.clean(text, 'vowels')
ProfanityFilter::Base.clean(text, 'hollow')

ProfanityFilter::Base.profane?(text) #=> true/false

3. 项目API使用文档

目前项目的API主要包括以下几个方法：

• clean(text, method = nil)：清洗文本中的不当言论。可以指定过滤方法，默认为nil。
• profane?(text)：判断文本中是否包含不当言论。

更多API详细信息，请参考项目源代码。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，请参考上文。