SimpleBlacklist
This project is designed to make easy the task of sanitizing string that contains words not allowed.
Installation
Add this line to your application's Gemfile:
gem 'simple_blacklist'
And then execute:
$ bundle
Or install it yourself as:
$ gem install simple_blacklist
Setup (Rails)
$ simple_blacklist --configure
Will be created:
- config/initializers/simple_blacklist.rb (file where are defined some parameters to the gem)
- config/blacklist.yml (list where you must add words that you want deny)
Usage
In your code, do:
offensive_text = "Kiss my ass"
SimpleBlacklist.sanitize(offensive_text)
# "Kiss my ****"
If configured letters_variations is also possible to sanitize texts written with special characters
offensive_text = "Kiss my @$$"
SimpleBlacklist.sanitize(offensive_text)
# "Kiss my ****"
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_blacklist. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.