profane 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use --create 1.9.3@profane

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in profane.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jonan Scheffler
+
+MIT License
+
+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,72 @@
+# Profane
+
+Profane is a basic profanity filter designed to filter and detect keywords based
+on an internal or external dictionary, or a combination of both.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'profane'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install profane
+
+## Configuration
+
+You can include words from your own dictionary in a hash or a yaml file, where
+the key is the target word and the value is an obfuscated replacement you would
+like to use.
+
+Adding words to the dictionary with a hash:
+```
+Profane.configure(dictionary: { obscenity: 'obs******', vulgarity: 'vul******' })
+```
+
+Adding words to the dictionary with a yml file:
+```
+Profane.configure(dictionary_file: 'config/dictionary.yml')
+```
+
+You can override the entire dictionary with your own by setting
+use_internal_dictionary to false.
+```
+Profane.configure(dictionary: { obscenity: 'obs******' }, use_internal_dictionary: false)
+Profane.configure(dictionary_file: 'config/dictionary.yml', use_internal_dictionary: false)
+```
+
+If you set a key to '' in the dictionary profane will use the default strategy
+of overwriting the entire word (exempting punctuation) with '*'. You can pass an
+alternative character to use with the filter_character option.
+```
+Profane.configure(filter_character: '&')
+```
+Note that if you want to actually replace words with blank string you can use ''
+as your default character.
+
+## Usage
+
+Filter profanity from a bit of text:
+```
+Profane::Filter.filter('Voldemort!')
+=> '*********!')
+```
+
+Detect profanity in a bit of text:
+```
+Profane::Filter.profane?('If you come to a fork in the road, take it.')
+=> 'false'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/config/dictionary.yml

@@ -0,0 +1,453 @@
+---
+4r5e: ''
+5h1t: ''
+5hit: ''
+a55: ''
+anal: ''
+anus: ''
+ar5e: ''
+arrse: ''
+arse: ''
+ass: ''
+ass-fucker: ''
+asses: ''
+assfucker: ''
+assfukka: ''
+asshole: ''
+assholes: ''
+asswhole: ''
+a_s_s: ''
+b!tch: ''
+b00bs: ''
+b17ch: ''
+b1tch: ''
+ballbag: ''
+balls: ''
+ballsack: ''
+bastard: ''
+beastial: ''
+beastiality: ''
+bellend: ''
+bestial: ''
+bestiality: ''
+bi+ch: ''
+biatch: ''
+bitch: ''
+bitcher: ''
+bitchers: ''
+bitches: ''
+bitchin: ''
+bitching: ''
+bloody: ''
+blow job: ''
+blowjob: ''
+blowjobs: ''
+boiolas: ''
+bollock: ''
+bollok: ''
+boner: ''
+boob: ''
+boobs: ''
+booobs: ''
+boooobs: ''
+booooobs: ''
+boooooobs: ''
+booooooobs: ''
+breasts: ''
+buceta: ''
+bugger: ''
+bum: ''
+bunny fucker: ''
+butt: ''
+butthole: ''
+buttmuch: ''
+buttplug: ''
+c0ck: ''
+c0cksucker: ''
+carpet muncher: ''
+cawk: ''
+chink: ''
+cipa: ''
+cl1t: ''
+clit: ''
+clitoris: ''
+clits: ''
+cnut: ''
+cock: ''
+cock-sucker: ''
+cockface: ''
+cockhead: ''
+cockmunch: ''
+cockmuncher: ''
+cocks: ''
+! 'cocksuck ': ''
+! 'cocksucked ': ''
+cocksucker: ''
+cocksucking: ''
+! 'cocksucks ': ''
+cocksuka: ''
+cocksukka: ''
+cok: ''
+cokmuncher: ''
+coksucka: ''
+coon: ''
+cox: ''
+crap: ''
+cum: ''
+cummer: ''
+cumming: ''
+cums: ''
+cumshot: ''
+cunilingus: ''
+cunillingus: ''
+cunnilingus: ''
+cunt: ''
+! 'cuntlick ': ''
+! 'cuntlicker ': ''
+! 'cuntlicking ': ''
+cunts: ''
+cyalis: ''
+cyberfuc: ''
+! 'cyberfuck ': ''
+! 'cyberfucked ': ''
+cyberfucker: ''
+cyberfuckers: ''
+! 'cyberfucking ': ''
+d1ck: ''
+damn: ''
+dick: ''
+dickhead: ''
+dildo: ''
+dildos: ''
+dink: ''
+dinks: ''
+dirsa: ''
+dlck: ''
+dog-fucker: ''
+doggin: ''
+dogging: ''
+donkeyribber: ''
+doosh: ''
+duche: ''
+dyke: ''
+ejaculate: ''
+ejaculated: ''
+! 'ejaculates ': ''
+! 'ejaculating ': ''
+ejaculatings: ''
+ejaculation: ''
+ejakulate: ''
+f u c k: ''
+f u c k e r: ''
+f4nny: ''
+fag: ''
+fagging: ''
+faggitt: ''
+faggot: ''
+faggs: ''
+fagot: ''
+fagots: ''
+fags: ''
+fanny: ''
+fannyflaps: ''
+fannyfucker: ''
+fanyy: ''
+fatass: ''
+fcuk: ''
+fcuker: ''
+fcuking: ''
+feck: ''
+fecker: ''
+felching: ''
+fellate: ''
+fellatio: ''
+! 'fingerfuck ': ''
+! 'fingerfucked ': ''
+! 'fingerfucker ': ''
+fingerfuckers: ''
+! 'fingerfucking ': ''
+! 'fingerfucks ': ''
+fistfuck: ''
+! 'fistfucked ': ''
+! 'fistfucker ': ''
+! 'fistfuckers ': ''
+! 'fistfucking ': ''
+! 'fistfuckings ': ''
+! 'fistfucks ': ''
+flange: ''
+fook: ''
+fooker: ''
+fuck: ''
+fucka: ''
+fucked: ''
+fucker: ''
+fuckers: ''
+fuckhead: ''
+fuckheads: ''
+fuckin: ''
+fucking: ''
+fuckings: ''
+fuckingshitmotherfucker: ''
+! 'fuckme ': ''
+fucks: ''
+fuckwhit: ''
+fuckwit: ''
+fudge packer: ''
+fudgepacker: ''
+fuk: ''
+fuker: ''
+fukker: ''
+fukkin: ''
+fuks: ''
+fukwhit: ''
+fukwit: ''
+fux: ''
+fux0r: ''
+f_u_c_k: ''
+gangbang: ''
+! 'gangbanged ': ''
+! 'gangbangs ': ''
+gaylord: ''
+gaysex: ''
+goatse: ''
+God: ''
+god-dam: ''
+god-damned: ''
+goddamn: ''
+goddamned: ''
+! 'hardcoresex ': ''
+hell: ''
+heshe: ''
+hoar: ''
+hoare: ''
+hoer: ''
+homo: ''
+hore: ''
+horniest: ''
+horny: ''
+hotsex: ''
+! 'jack-off ': ''
+jackoff: ''
+jap: ''
+! 'jerk-off ': ''
+jism: ''
+! 'jiz ': ''
+! 'jizm ': ''
+jizz: ''
+kawk: ''
+knob: ''
+knobead: ''
+knobed: ''
+knobend: ''
+knobhead: ''
+knobjocky: ''
+knobjokey: ''
+kock: ''
+kondum: ''
+kondums: ''
+kum: ''
+kummer: ''
+kumming: ''
+kums: ''
+kunilingus: ''
+l3i+ch: ''
+l3itch: ''
+labia: ''
+lmfao: ''
+lust: ''
+lusting: ''
+m0f0: ''
+m0fo: ''
+m45terbate: ''
+ma5terb8: ''
+ma5terbate: ''
+masochist: ''
+master-bate: ''
+masterb8: ''
+masterbat*: ''
+masterbat3: ''
+masterbate: ''
+masterbation: ''
+masterbations: ''
+masturbate: ''
+mo-fo: ''
+mof0: ''
+mofo: ''
+mothafuck: ''
+mothafucka: ''
+mothafuckas: ''
+mothafuckaz: ''
+! 'mothafucked ': ''
+mothafucker: ''
+mothafuckers: ''
+mothafuckin: ''
+! 'mothafucking ': ''
+mothafuckings: ''
+mothafucks: ''
+mother fucker: ''
+motherfuck: ''
+motherfucked: ''
+motherfucker: ''
+motherfuckers: ''
+motherfuckin: ''
+motherfucking: ''
+motherfuckings: ''
+motherfuckka: ''
+motherfucks: ''
+muff: ''
+mutha: ''
+muthafecker: ''
+muthafuckker: ''
+muther: ''
+mutherfucker: ''
+n1gga: ''
+n1gger: ''
+nazi: ''
+nigg3r: ''
+nigg4h: ''
+nigga: ''
+niggah: ''
+niggas: ''
+niggaz: ''
+nigger: ''
+! 'niggers ': ''
+nob: ''
+nob jokey: ''
+nobhead: ''
+nobjocky: ''
+nobjokey: ''
+numbnuts: ''
+nutsack: ''
+! 'orgasim ': ''
+! 'orgasims ': ''
+orgasm: ''
+! 'orgasms ': ''
+p0rn: ''
+pawn: ''
+pecker: ''
+penis: ''
+penisfucker: ''
+phonesex: ''
+phuck: ''
+phuk: ''
+phuked: ''
+phuking: ''
+phukked: ''
+phukking: ''
+phuks: ''
+phuq: ''
+pigfucker: ''
+pimpis: ''
+piss: ''
+pissed: ''
+pisser: ''
+pissers: ''
+! 'pisses ': ''
+pissflaps: ''
+! 'pissin ': ''
+pissing: ''
+! 'pissoff ': ''
+poop: ''
+porn: ''
+porno: ''
+pornography: ''
+pornos: ''
+prick: ''
+! 'pricks ': ''
+pron: ''
+pube: ''
+pusse: ''
+pussi: ''
+pussies: ''
+pussy: ''
+! 'pussys ': ''
+rectum: ''
+retard: ''
+rimjaw: ''
+rimming: ''
+s hit: ''
+s.o.b.: ''
+sadist: ''
+schlong: ''
+screwing: ''
+scroat: ''
+scrote: ''
+scrotum: ''
+semen: ''
+sex: ''
+sh!+: ''
+sh!t: ''
+sh1t: ''
+shag: ''
+shagger: ''
+shaggin: ''
+shagging: ''
+shemale: ''
+shi+: ''
+shit: ''
+shitdick: ''
+shite: ''
+shited: ''
+shitey: ''
+shitfuck: ''
+shitfull: ''
+shithead: ''
+shiting: ''
+shitings: ''
+shits: ''
+shitted: ''
+shitter: ''
+! 'shitters ': ''
+shitting: ''
+shittings: ''
+! 'shitty ': ''
+skank: ''
+slut: ''
+sluts: ''
+smegma: ''
+smut: ''
+snatch: ''
+son-of-a-bitch: ''
+spac: ''
+spunk: ''
+s_h_i_t: ''
+t1tt1e5: ''
+t1tties: ''
+teets: ''
+teez: ''
+testical: ''
+testicle: ''
+tit: ''
+titfuck: ''
+tits: ''
+titt: ''
+tittie5: ''
+tittiefucker: ''
+titties: ''
+tittyfuck: ''
+tittywank: ''
+titwank: ''
+tosser: ''
+turd: ''
+tw4t: ''
+twat: ''
+twathead: ''
+twatty: ''
+twunt: ''
+twunter: ''
+v14gra: ''
+v1gra: ''
+vagina: ''
+viagra: ''
+vulva: ''
+w00se: ''
+wang: ''
+wank: ''
+wanker: ''
+wanky: ''
+whoar: ''
+whore: ''
+willies: ''
+willy: ''
+xrated: ''
+xxx: ''

data/lib/profane/filter.rb

@@ -0,0 +1,39 @@
+module Profane
+  class Filter
+    attr_accessor :dictionary, :character, :dictionary_regex
+
+    def initialize
+      @dictionary = Profane.dictionary
+      @character = Profane.character
+    end
+
+    def filter(phrase)
+      new_phrase = phrase.split(' ').map do |word|
+        cleanse!(word)
+      end
+
+      Array(new_phrase).join(' ')
+    end
+
+    def profane?(phrase)
+      phrase = phrase.downcase.split(' ')
+
+      dictionary.keys.each do |key|
+        return true unless phrase.grep(/(\b|\W)#{key.downcase}(\b|\W)/).empty?
+      end
+
+      false
+    end
+
+    def cleanse!(word)
+      value = dictionary[word.match(/\w+/).to_s]
+      return word unless value
+
+      if value == ''
+        word.gsub!(/\w/, character)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/profane/version.rb

@@ -0,0 +1,3 @@
+module Profane
+  VERSION = "0.0.1"
+end

data/lib/profane.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+require 'profane/version'
+require 'profane/filter'
+
+module Profane
+  DICTIONARY_PATH = 'config/dictionary.yml'
+
+  def self.configure(options)
+    config.merge!(options)
+  end
+
+  def self.config
+    @config ||= set_default_config
+  end
+
+  def self.set_default_config
+    @config = { use_internal_dictionary: true }
+  end
+
+  def self.dictionary
+    stringify_keys(load_dictionary)
+  end
+
+  def self.stringify_keys(hash)
+    hash.keys.each do |key|
+      hash[key.to_s] = hash.delete(key)
+    end
+
+    hash
+  end
+
+  def self.character
+    config[:filter_character] || '*'
+  end
+
+  def self.load_dictionary
+    yaml_dictionary = load_yaml_dictionary
+
+    if config[:use_internal_dictionary]
+      yaml_dictionary.merge (config[:dictionary] || {})
+    else
+      config[:dictionary]
+    end
+  end
+
+  def self.load_yaml_dictionary
+    custom_dictionary = load_custom_yaml_dictionary
+
+    if config[:use_internal_dictionary]
+      load_internal_yaml_dictionary.merge custom_dictionary
+    else
+      custom_dictionary
+    end
+  end
+
+  def self.load_internal_yaml_dictionary
+    internal_dictionary = YAML.load(File.read(DICTIONARY_PATH))
+  end
+
+  def self.load_custom_yaml_dictionary
+    path = config[:dictionary_file]
+
+    if path && File.exist?(path)
+      YAML.load(File.read(config[:dictionary_file]))
+    else
+      {}
+    end
+  end
+end

data/profane.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'profane/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "profane"
+  spec.version       = Profane::VERSION
+  spec.authors       = ["Jonan Scheffler"]
+  spec.email         = ["jonanscheffler@gmail.com"]
+  spec.description   = %q{A simple, flexible profanity filter.}
+  spec.summary       = %q{Profane is a basic profanity filter designed to filter and detect keywords based on an internal or external dictionary, or a combination of both.}
+  spec.homepage      = "http://github.com/1337807/profane"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "yaml"
+end

data/profanity.txt

@@ -0,0 +1,452 @@
+4r5e
+5h1t
+5hit
+a55
+anal
+anus
+ar5e
+arrse
+arse
+ass
+ass-fucker
+asses
+assfucker
+assfukka
+asshole
+assholes
+asswhole
+a_s_s
+b!tch
+b00bs
+b17ch
+b1tch
+ballbag
+balls
+ballsack
+bastard
+beastial
+beastiality
+bellend
+bestial
+bestiality
+bi+ch
+biatch
+bitch
+bitcher
+bitchers
+bitches
+bitchin
+bitching
+bloody
+blow job
+blowjob
+blowjobs
+boiolas
+bollock
+bollok
+boner
+boob
+boobs
+booobs
+boooobs
+booooobs
+boooooobs
+booooooobs
+breasts
+buceta
+bugger
+bum
+bunny fucker
+butt
+butthole
+buttmuch
+buttplug
+c0ck
+c0cksucker
+carpet muncher
+cawk
+chink
+cipa
+cl1t
+clit
+clitoris
+clits
+cnut
+cock
+cock-sucker
+cockface
+cockhead
+cockmunch
+cockmuncher
+cocks
+cocksuck 
+cocksucked 
+cocksucker
+cocksucking
+cocksucks 
+cocksuka
+cocksukka
+cok
+cokmuncher
+coksucka
+coon
+cox
+crap
+cum
+cummer
+cumming
+cums
+cumshot
+cunilingus
+cunillingus
+cunnilingus
+cunt
+cuntlick 
+cuntlicker 
+cuntlicking 
+cunts
+cyalis
+cyberfuc
+cyberfuck 
+cyberfucked 
+cyberfucker
+cyberfuckers
+cyberfucking 
+d1ck
+damn
+dick
+dickhead
+dildo
+dildos
+dink
+dinks
+dirsa
+dlck
+dog-fucker
+doggin
+dogging
+donkeyribber
+doosh
+duche
+dyke
+ejaculate
+ejaculated
+ejaculates 
+ejaculating 
+ejaculatings
+ejaculation
+ejakulate
+f u c k
+f u c k e r
+f4nny
+fag
+fagging
+faggitt
+faggot
+faggs
+fagot
+fagots
+fags
+fanny
+fannyflaps
+fannyfucker
+fanyy
+fatass
+fcuk
+fcuker
+fcuking
+feck
+fecker
+felching
+fellate
+fellatio
+fingerfuck 
+fingerfucked 
+fingerfucker 
+fingerfuckers
+fingerfucking 
+fingerfucks 
+fistfuck
+fistfucked 
+fistfucker 
+fistfuckers 
+fistfucking 
+fistfuckings 
+fistfucks 
+flange
+fook
+fooker
+fuck
+fucka
+fucked
+fucker
+fuckers
+fuckhead
+fuckheads
+fuckin
+fucking
+fuckings
+fuckingshitmotherfucker
+fuckme 
+fucks
+fuckwhit
+fuckwit
+fudge packer
+fudgepacker
+fuk
+fuker
+fukker
+fukkin
+fuks
+fukwhit
+fukwit
+fux
+fux0r
+f_u_c_k
+gangbang
+gangbanged 
+gangbangs 
+gaylord
+gaysex
+goatse
+God
+god-dam
+god-damned
+goddamn
+goddamned
+hardcoresex 
+hell
+heshe
+hoar
+hoare
+hoer
+homo
+hore
+horniest
+horny
+hotsex
+jack-off 
+jackoff
+jap
+jerk-off 
+jism
+jiz 
+jizm 
+jizz
+kawk
+knob
+knobead
+knobed
+knobend
+knobhead
+knobjocky
+knobjokey
+kock
+kondum
+kondums
+kum
+kummer
+kumming
+kums
+kunilingus
+l3i+ch
+l3itch
+labia
+lmfao
+lust
+lusting
+m0f0
+m0fo
+m45terbate
+ma5terb8
+ma5terbate
+masochist
+master-bate
+masterb8
+masterbat*
+masterbat3
+masterbate
+masterbation
+masterbations
+masturbate
+mo-fo
+mof0
+mofo
+mothafuck
+mothafucka
+mothafuckas
+mothafuckaz
+mothafucked 
+mothafucker
+mothafuckers
+mothafuckin
+mothafucking 
+mothafuckings
+mothafucks
+mother fucker
+motherfuck
+motherfucked
+motherfucker
+motherfuckers
+motherfuckin
+motherfucking
+motherfuckings
+motherfuckka
+motherfucks
+muff
+mutha
+muthafecker
+muthafuckker
+muther
+mutherfucker
+n1gga
+n1gger
+nazi
+nigg3r
+nigg4h
+nigga
+niggah
+niggas
+niggaz
+nigger
+niggers 
+nob
+nob jokey
+nobhead
+nobjocky
+nobjokey
+numbnuts
+nutsack
+orgasim 
+orgasims 
+orgasm
+orgasms 
+p0rn
+pawn
+pecker
+penis
+penisfucker
+phonesex
+phuck
+phuk
+phuked
+phuking
+phukked
+phukking
+phuks
+phuq
+pigfucker
+pimpis
+piss
+pissed
+pisser
+pissers
+pisses 
+pissflaps
+pissin 
+pissing
+pissoff 
+poop
+porn
+porno
+pornography
+pornos
+prick
+pricks 
+pron
+pube
+pusse
+pussi
+pussies
+pussy
+pussys 
+rectum
+retard
+rimjaw
+rimming
+s hit
+s.o.b.
+sadist
+schlong
+screwing
+scroat
+scrote
+scrotum
+semen
+sex
+sh!+
+sh!t
+sh1t
+shag
+shagger
+shaggin
+shagging
+shemale
+shi+
+shit
+shitdick
+shite
+shited
+shitey
+shitfuck
+shitfull
+shithead
+shiting
+shitings
+shits
+shitted
+shitter
+shitters 
+shitting
+shittings
+shitty 
+skank
+slut
+sluts
+smegma
+smut
+snatch
+son-of-a-bitch
+spac
+spunk
+s_h_i_t
+t1tt1e5
+t1tties
+teets
+teez
+testical
+testicle
+tit
+titfuck
+tits
+titt
+tittie5
+tittiefucker
+titties
+tittyfuck
+tittywank
+titwank
+tosser
+turd
+tw4t
+twat
+twathead
+twatty
+twunt
+twunter
+v14gra
+v1gra
+vagina
+viagra
+vulva
+w00se
+wang
+wank
+wanker
+wanky
+whoar
+whore
+willies
+willy
+xrated
+xxx:1

data/spec/profane/filter_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe 'Profane::Filter' do
+  before do
+    Profane.set_default_config
+  end
+
+  context "#filter" do
+    it "filters words from the dictionary using the default character" do
+      filter = Profane::Filter.new
+
+      filter.filter('fuck').should == '****'
+    end
+
+    it "filters words from the dictionary ignoring punctuation" do
+      filter = Profane::Filter.new
+
+      filter.filter('fuck!').should == '****!'
+    end
+
+    it "filters words from the dictionary using a custom character" do
+      Profane.configure(filter_character: '&')
+      filter = Profane::Filter.new
+
+      filter.filter('fuck!').should == '&&&&!'
+
+      Profane.configure(filter_character: '*')
+    end
+
+    context "when configured with a custom dictionary" do
+      it "filters words from the custom dictionary with string keys" do
+        Profane.configure(dictionary: { 'shit' => '' })
+        filter = Profane::Filter.new
+
+        filter.filter('shit!?').should == '****!?'
+      end
+
+      it "filters words from the custom dictionary with symbol keys" do
+        Profane.configure(dictionary: { :shit => '' })
+        filter = Profane::Filter.new
+
+        filter.filter('shit!?').should == '****!?'
+      end
+
+      it "filters words from the default dictionary" do
+        Profane.stub(:load_yaml_dictionary).and_return({ 'shit' => '' })
+        filter = Profane::Filter.new
+
+        filter.filter('shit!?').should == '****!?'
+      end
+    end
+
+    context "when configured not to use the internal dictionary" do
+      before do
+        Profane.configure(dictionary: { 'shit' => '' }, use_internal_dictionary: false)
+      end
+
+      it "filters words from the custom dictionary" do
+        filter = Profane::Filter.new
+        filter.filter('shit!?').should == '****!?'
+      end
+
+      it "doesn't filter words from the default dictionary" do
+        filter = Profane::Filter.new
+        filter.filter('fuck!?').should == 'fuck!?'
+      end
+    end
+  end
+
+  context "#profane?" do
+    it "returns false if the phrase is not profane" do
+      filter = Profane::Filter.new
+      filter.profane?('this is not profane').should be_false
+    end
+
+    it "detects the presence of words from the default dictionary" do
+      filter = Profane::Filter.new
+      filter.profane?('fuck').should be_true
+    end
+
+    it "detects the presence of words from the custom dictionary" do
+      Profane.configure(dictionary: { 'microsoft' => '' })
+      filter = Profane::Filter.new
+      filter.profane?('microsoft').should be_true
+    end
+
+    it "ignores case" do
+      filter = Profane::Filter.new
+      filter.profane?('ruby is the SHIT').should be_true
+    end
+
+    it "detects profanity in quotes" do
+      filter = Profane::Filter.new
+      filter.profane?("ruby is the 'SHIT'").should be_true
+    end
+
+    it "detects profanity surrounded by non-word characters" do
+      filter = Profane::Filter.new
+      filter.profane?("ruby is the -SHIT-").should be_true
+    end
+  end
+end

data/spec/profane_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Profane do
+  before do
+    Profane.set_default_config
+  end
+
+  context "without configuration options" do
+    it "loads the default dictionary" do
+      Profane.dictionary['fuck'].should == ''
+    end
+  end
+
+  context "with configuration options" do
+    it "includes the supplied configuration options with the defaults" do
+      Profane.configure(dictionary: { geega: 'bobby pants' })
+      Profane.config[:dictionary][:geega].should == 'bobby pants'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'profane'

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: profane
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jonan Scheffler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yaml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple, flexible profanity filter.
+email:
+- jonanscheffler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/dictionary.yml
+- lib/profane.rb
+- lib/profane/filter.rb
+- lib/profane/version.rb
+- profane.gemspec
+- profanity.txt
+- spec/profane/filter_spec.rb
+- spec/profane_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/1337807/profane
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Profane is a basic profanity filter designed to filter and detect keywords
+  based on an internal or external dictionary, or a combination of both.
+test_files:
+- spec/profane/filter_spec.rb
+- spec/profane_spec.rb
+- spec/spec_helper.rb