obscenity-plus 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e372fa6a81928b0052940a66549255cb6d31c9086c660bcc6263cf105b2d44f5
+  data.tar.gz: 12def6afadcb1d3e18e1843f5740c834e953378e8f70438d00e32c4b9b0a2cc0
+SHA512:
+  metadata.gz: ec978321c46dc22d603c0127dc966ecb4f24ed66c376024ff275f98f48ffd9a48768fc69f63fe1c05bf9fd470969198f1dfb36a7fd2d79c4d595985d69e891c6
+  data.tar.gz: 57aa32b94c376281eeee8bfbe01dfd4a57bf2c422c75d115e9de818e3684df9fbb9537d5e9e5975f665c203ba80ad68bbe4e07cca269419e47204df5ca90d995

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Ropetow
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,297 @@
+# NOTE: This is a forked project. 
+
+# Obscenity-plus: A work in progress. 
+
+Obscenity is a profanity filter gem for Ruby/Rubinius, Rails (through ActiveModel), and Rack middleware.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'obscenity-plus'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+
+```ruby
+gem install obscenity-plus
+```
+
+## Compatibility
+
+Obscenity is compatible is a work in progress. Aiming for rails 8+ and ruby 3+.
+
+## Using Obscenity
+
+The following methods are available to use with Obscenity:
+
+### Configuration
+
+`Obscenity.configure(&block)` allows you to set custom global configuration options. Available options are:
+
+`config.blacklist` accepts the following values:
+
+- An array with words
+- A string representing a path to a yml file
+- A Pathname object with a path to a yml file
+
+`config.whitelist` accepts the following values:
+
+- An array with words
+- A string representing a path to a yml file
+- A Pathname object with a path to a yml file
+
+`config.replacement` accepts the following values:
+
+- :default        : Uses the :garbled method
+- :garbled        : Replaces profane words with $@!#%
+- :stars          : Replaces profane words with '*' up to the word's length
+- :vowels         : Replaces the vowels in the profane word with '*'
+- :nonconsonants  : Replaces non consonants with '*'
+- "custom string" : Replaces the profane word with the custom string
+
+Example:
+
+```ruby
+Obscenity.configure do |config|
+  config.blacklist   = "path/to/blacklist/file.yml"
+  config.whitelist   = ["safe", "word"]
+  config.replacement = :stars
+end
+```
+
+### Basic Usage
+
+`Obscenity.profane?(text)` analyses the content and returns `true` or `false` based on its profanity:
+
+```ruby
+Obscenity.profane?("simple text")
+=> false
+
+Obscenity.profane?("text with shit")
+=> true
+```
+
+`Obscenity.sanitize(text)` sanities the content and returns a new sanitized content (if profane) or the original content (if not profane):
+
+```ruby
+Obscenity.sanitize("simple text")
+=> "simple text"
+
+Obscenity.sanitize("text with shit")
+=> "text with $@!#%"
+```
+    
+`Obscenity.replacement(style).sanitize(text)` allows you to pass the replacement method to be used when sanitizing the given content. Available replacement values are `:default`, `:garbled`, `:stars`, `:vowels`, and a custom string.
+
+```ruby
+Obscenity.replacement(:default).sanitize("text with shit")
+=> "text with $@!#%"
+
+Obscenity.replacement(:garbled).sanitize("text with shit")
+=> "text with $@!#%"
+
+Obscenity.replacement(:stars).sanitize("text with shit")
+=> "text with ****"
+
+Obscenity.replacement(:vowels).sanitize("text with shit")
+=> "text with sh*t"
+
+Obscenity.replacement(:nonconsonants).sanitize('Oh 5hit')
+=> "Oh *h*t"
+
+Obscenity.replacement("[censored]").sanitize("text with shit")
+=> "text with [censored]"
+```
+
+`Obscenity.offensive(text)` returns an array of profane words in the given content:
+
+```ruby
+Obscenity.offensive("simple text")
+=> []
+
+Obscenity.offensive("text with shit and another biatch")
+=> ["shit", "biatch"]
+```
+
+### ActiveModel
+
+The ActiveModel component provides easy profanity validation for your models.
+
+First, you need to explicitly require the ActiveModel component: 
+
+```ruby
+require 'obscenity/active_model'
+```
+
+Then you can use it in your models as such:
+
+```ruby
+# ActiveRecord example
+class Post < ActiveRecord::Base
+  
+  validates :title, obscenity: true
+  validates :body,  obscenity: { sanitize: true, replacement: "[censored]" }
+end
+
+# MongoMapper example
+class Book
+  include MongoMapper::Document
+
+  key :title, String
+  key :body,  String
+
+  validates :title, obscenity: true
+  validates :body,  obscenity: { sanitize: true, replacement: :vowels }
+end
+
+# Mongoid example
+class Page
+  include Mongoid::Document
+
+  field :title, type: String
+  field :body,  type: String
+
+  validates :title, obscenity: true
+  validates :body,  obscenity: { sanitize: true, replacement: :garbled }
+end
+```
+
+The following usage is available:
+
+`obscenity: true` : Does a profanity validation in the field using `.profane?` and returns `true/false`. If true, ActiveModel's Validation will return a default error message.
+
+`obscenity: { message: 'Custom message' }` : Does a profanity validation in the field using `.profane?` and returns `true/false`. If true, ActiveModel's Validation will return your custom error message.
+
+`obscenity: { sanitize: true }` : Silently sanitizes the field and replaces its content with the sanitized version. If the `:replacement` key is included, it will use that style when replacing the content.
+
+### Rack middleware
+
+You can use Obscenity as a Rack middleware to automatically reject requests that include profane parameter values or sanitize those values before they reach your Application.
+
+First you need to explicitly require the Rack middleware:
+
+```ruby
+require 'obscenity/rack'
+```
+
+And to use the middleware, the basic syntax is:
+
+```ruby
+use Rack::Obscenity, {} # options Hash
+```
+
+You need to use the options below inside the options Hash (above)
+
+#### Rejecting Requests:
+
+Any of the following options can be used to reject a request.
+
+`reject: true` : will reject a request if any parameter value contains profanity.
+
+```ruby
+use Rack::Obscenity, reject: true
+```
+
+`reject: { params: [] }` : will analyze the selected parameters and reject the request if their values contain profanity.
+
+```ruby
+use Rack::Obscenity, reject: { params: [:foo, :bar] }
+```
+
+`reject: { message: 'Custom message' }` : will reject a request and display the custom message if any parameter value contains profanity
+
+```ruby
+use Rack::Obscenity, reject: { message: "We don't allow profanity!" }
+```
+
+`reject: { path: 'path/to/file' }` :  will reject a request and render the custom file if any parameter value contains profanity
+
+```ruby
+use Rack::Obscenity, reject: { path: 'public/no_profanity.html' }
+```
+
+More usage example:
+
+```ruby
+# Rejects the request for all params and renders a file
+use Rack::Obscenity, reject: { params: :all, path: 'public/no_profanity.html' }
+
+# Rejects the request based on the selected params and renders a file
+use Rack::Obscenity, reject: { params: [:foo, :bar], path: 'public/no_profanity.html' }
+
+# Rejects the request based on the selected params and displays a message
+use Rack::Obscenity, reject: { params: [:foo, :bar], message: "Profanity is not allowed!" }
+```
+
+#### Sanitizing Requests:
+
+Any of the following options can be used to sanitize a request.
+
+`sanitize: true` : will sanitize all parameter values if they contain profanity.
+
+```ruby
+use Rack::Obscenity, sanitize: true
+```
+
+`sanitize: { params: [] }` : will analyze the selected parameters and sanitize them if their values contain profanity.
+
+```ruby
+use Rack::Obscenity, sanitize: { params: [:foo, :bar] }
+```
+
+`sanitize: { replacement: (:default | :garbled | :stars | :vowels | 'custom') }` : will use this replacement method when sanitizing parameter values
+
+```ruby
+use Rack::Obscenity, sanitize: { replacement: :vowels }
+```
+
+More usage example:
+
+```ruby
+# Sanitizes all params and replaces their values using :stars
+use Rack::Obscenity, sanitize: { params: :all, replacement: :stars }
+
+# Sanitizes the given params and replaces their values using a custom word
+use Rack::Obscenity, sanitize: { params: [:foo, :bar], replacement: "[censored]" }
+
+# Sanitizes all params and replaces their values using :garbled
+use Rack::Obscenity, sanitize: { replacement: :garbled }
+```
+### Test Helpers
+
+Obscenity currently provides test helpers for RSpec only, but we have plans to add helpers to Shoulda as well.
+
+#### RSpec Matcher
+
+A `be_profane` matcher is available for RSpec. Its usage is very simple:
+
+```ruby
+user.username.should_not be_profane
+```
+
+## Contributing to obscenity
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history.
+
+## Authors
+
+* Thiago Jackiw: [@tjackiw](http://twitter.com/tjackiw)
+
+## Copyright
+
+Copyright (c) 2025 Ropetow. See LICENSE.txt for further details.
+