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

The Profanity Filter for Rails 技术文档

2024-12-26 03:07:30作者:滕妙奇

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

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

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
148
1.95 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
515