首页
/ The Profanity Filter for Rails 技术文档

The Profanity Filter for Rails 技术文档

2024-12-26 11:42:43作者:滕妙奇

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. 项目安装方式

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

热门项目推荐
相关项目推荐

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
49
39
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
254
63
mybatis-plusmybatis-plus
mybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com
Java
19
0
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
174
42
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
73
54
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
397
102
HarmonyOS-Cangjie-CasesHarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
55
2
PDFMathTranslatePDFMathTranslate
PDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/Docker
Python
32
3
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
26
18
topiam-eiamtopiam-eiam
开源IDaas/IAM平台,用于管理企业内员工账号、权限、身份认证、应用访问,帮助整合部署在本地或云端的内部办公系统、业务系统及三方 SaaS 系统的所有身份,实现一个账号打通所有应用的服务。
Java
19
0