Sha256: 14dd6984b8103a6d8edc872ff9c309ecc5bd06890fedbd8c5422600519a1b8a8

Contents?: true

Size: 669 Bytes

Versions: 8

Compression:

Stored size: 669 Bytes

Contents

# Swearjar

Simple profanity detection with content analysis.

## Installation

`gem install swearjar`

## Usage

```ruby
require "swearjar"

sj = Swearjar.default

sj.profane?("jim henson has a massive hard on he is gonna use to fuck everybody")
# => true

sj.scorecard("jim henson has a massive hard on he is gonna use to fuck everybody")
# => {:sexual => 2}

sj.censor("jim henson has a massive hard on he is gonna use to fuck everybody")
# => "jim henson has a massive **** ** he is gonna use to **** everybody"
```

To load from a custom config file, you can do the following:

```ruby
# For an example see lib/config/en.yml
sj = Swearjar.new("my_swears.yml")
```

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
swearjar-1.3.1 README.md
swearjar-1.3.0 README.md
swearjar-1.2.1 README.md
swearjar-1.2.0 README.md
swearjar-1.1.3 README.md
swearjar-1.1.2 README.md
swearjar-1.1.1 README.md
swearjar-1.1.0 README.md