pretty-profanity 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 698efd484610ee8a8dc5bb554b8b81dd41685625
+  data.tar.gz: a37d1ef50b9f4d109aa1696c52ea19030fb1ad7f
+SHA512:
+  metadata.gz: 62128de4d3007a7832aa9f498ddb5b8d928a021c9747716c739f3b3ed90e53c332772127f0d5addaa4145ed4e1db76bbb884c7acd77b1d65168d7b48689e075b
+  data.tar.gz: f6dd3b558b1a9de74040257807a5ccc495f1fbc212255117ffba7787f7b84ed8f94515141ff8802f8cb4d98e86b51fca1923526673253758137fdae1fea7a138

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require rspec/pride
+--format RSpec::Pride

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'pry'
+gem 'rspec', '~> 2.5'
+gem 'rspec-pride'

data/Gemfile.lock

@@ -0,0 +1,31 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.1.0)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.0)
+    rspec-expectations (2.99.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.1)
+    rspec-pride (2.3.0)
+      rspec (~> 2.10)
+    slop (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rake
+  rspec (~> 2.5)
+  rspec-pride

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/pretty-profanity.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.authors       = 'Blaine Schmeisser'
+  s.name          = 'pretty-profanity'
+  s.email         = 'blainesch@gmail.com'
+  s.homepage      = 'https://github.com/blainesch/pretty-profanity.rb'
+  s.version       = '0.0.2'
+  s.summary       = 'Cleans up profanity in text.'
+  s.description   = 'Cleans up profanity in text with blacklist, whitelists, and multiple types of sanitization rules. Easily add new sanitization rules.'
+  s.licenses      = ['MIT']
+  s.require_paths = ['src']
+  s.files         = `git ls-files`.split("\n")
+  s.has_rdoc      = false
+end

data/readme.md

@@ -0,0 +1,45 @@
+## Pretty Profanity
+Cleans up profanity in text.
+
+[![Build Status](https://travis-ci.org/blainesch/pretty-profanity.rb.svg?branch=master)](https://travis-ci.org/blainesch/pretty-profanity.rb)
+[![Code Climate](https://codeclimate.com/github/blainesch/pretty-profanity.rb.png)](https://codeclimate.com/github/blainesch/pretty-profanity.rb)
+
+## Setup
+~~~ ruby
+PrettyProfanity::Profanity.configure do |config|
+  config.blacklist = ['foo', 'bar']
+  config.whitelist = ['foo baz']
+  config.replacement = :vowels
+end
+~~~
+
+### Blacklist
+Whole words (or phrases) that you wish to remove. Because this requires whole words you'll need to add both `foo` and `foobaz`. The first will not match the second.
+
+### Whitelist
+Phrases that contain a word from the whitelist that you do not wish to remove. For instance you might blacklist `foo` but `foo baz` is acceptable.
+
+### Replacements
+Different replacements do different things. For instance the `:vowel` replacement just replaces vowels with stars, where the `:none` just deletes the word.
+* `:none` - Deletes the entire word.
+* `:star` - Stars the entire word.
+* `:vowels` - Stars just the vowels.
+* `:garbled` - Replaces each letter with garbled text `$@!#%`.
+* `:L337` - Replaces every character with 1337 speak.
+* `:piglatin` - Converts word to piglatin.
+
+## Creating Custom Replacements
+To create your own sanitization rules, open the class up, add your method and add it to your configuration.
+~~~ ruby
+module PrettyProfanity
+  class Sanitize
+    def reverse(word)
+      word.downcase.reverse
+    end
+  end
+end
+PrettyProfanity::Profanity.configure do |config|
+  # ...
+  config.replacement = :reverse
+end
+~~~

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'pry'
+require File.dirname(__FILE__) + "/../src/pretty-profanity"
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/src/pretty-profanity/profanity_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe PrettyProfanity::Profanity do
+
+  describe '.offensive' do
+
+      before do
+        PrettyProfanity::Profanity.configure do |config|
+          config.blacklist = ['php', 'asp', '.net']
+          config.whitelist = ['ugly php', 'ugly asp', 'ugly .net']
+          config.replacement = :none
+        end
+      end
+
+      it 'returns a list of offensive words' do
+        expect(PrettyProfanity::Profanity.offensive('I love php and asp! But not ugly .net.')).to eq(['php', 'asp'])
+      end
+
+      it 'doesnt break when I give it nil' do
+        expect(PrettyProfanity::Profanity.offensive(nil)).to eq([])
+      end
+
+  end
+
+  describe '.profane?' do
+
+    context 'a blacklist word' do
+
+      before do
+        PrettyProfanity::Profanity.configure do |config|
+          config.blacklist = ['php']
+          config.whitelist = []
+          config.replacement = :none
+        end
+      end
+
+      it 'returns true when that curse word is in my text' do
+        expect(PrettyProfanity::Profanity.profane?('I wrote an app in php!')).to be_truthy
+      end
+
+      it 'returns true when that curse word is in my text and capitalized' do
+        expect(PrettyProfanity::Profanity.profane?('I wrote an app in PHP!')).to be_truthy
+      end
+
+      it 'returns false when that curse word is in my text' do
+        expect(PrettyProfanity::Profanity.profane?('I wrote a ruby gem!')).to be_falsey
+      end
+
+    end
+
+    context 'a blacklist and a whitelist' do
+
+      before do
+        PrettyProfanity::Profanity.configure do |config|
+          config.blacklist = ['php']
+          config.whitelist = ['not using php']
+          config.replacement = :none
+        end
+      end
+
+      it 'does not filter when I am using the whitelist version' do
+        expect(PrettyProfanity::Profanity.profane?('I am not using php!')).to be_falsey
+      end
+
+    end
+
+  end
+
+  describe '.sanitize' do
+
+    context 'a blacklist word and replacement style' do
+
+      before do
+        PrettyProfanity::Profanity.configure do |config|
+          config.blacklist = ['php']
+          config.whitelist = []
+          config.replacement = :star
+        end
+      end
+
+      it 'replaces the blacklisted word with stars' do
+        expect(PrettyProfanity::Profanity.sanitize('I wrote an app in php!')).to eq('I wrote an app in ***!')
+      end
+
+      it 'replaces none of the good words' do
+        expect(PrettyProfanity::Profanity.sanitize('I wrote a ruby gem!')).to eq('I wrote a ruby gem!')
+      end
+
+    end
+
+    context 'a blacklist and a whitelist' do
+
+      before do
+        PrettyProfanity::Profanity.configure do |config|
+          config.blacklist = ['php']
+          config.whitelist = ['not using php']
+          config.replacement = :star
+        end
+      end
+
+      it 'does not filter when I am using the whitelist version' do
+        expect(PrettyProfanity::Profanity.sanitize('I am not using php!')).to eq('I am not using php!')
+      end
+
+    end
+
+  end
+
+end

data/spec/src/pretty-profanity/sanitize_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe PrettyProfanity::Sanitize do
+
+  describe '#none' do
+    it 'returns an empty string' do
+      expect(subject.none('hello')).to eq('')
+    end
+  end
+
+  describe '#vowels' do
+    it 'replaces vowels with stars' do
+      expect(subject.vowels('hello')).to eq('h*ll*')
+    end
+  end
+
+  describe '#star' do
+    it 'replaces characters with stars' do
+      expect(subject.star('hello')).to eq('*****')
+    end
+  end
+
+  describe '#garbled' do
+
+    it 'returns a a string just as long' do
+      expect(subject.garbled('hello').length).to eq(5)
+      expect(subject.garbled('helloworld').length).to eq(10)
+    end
+
+    it 'matches just garbled characters' do
+      expect(subject.garbled('helloworldhowareyou')).to match(/[$@!#%]+/)
+    end
+
+  end
+
+  describe '#hollow' do
+
+    it 'stars out inner word' do
+      expect(subject.hollow('foobar')).to eq('f****r')
+    end
+
+    it 'leaves two letter words alone' do
+      expect(subject.hollow('hi')).to eq('hi')
+    end
+
+  end
+
+  describe '#L337' do
+
+    it 'gives back 1337 speak' do
+      expect(subject.L337('foobar')).to eq('Ph00B4R')
+    end
+
+  end
+
+  describe '#piglatin' do
+
+    it 'converts to pig latin examples taken from wikipedia' do
+      expect(subject.piglatin('happy')).to eq('appyhay')
+      expect(subject.piglatin('duck')).to eq('uckday')
+      expect(subject.piglatin('glove')).to eq('oveglay')
+      expect(subject.piglatin('egg')).to eq('eggway')
+      expect(subject.piglatin('inbox')).to eq('inboxway')
+      expect(subject.piglatin('eight')).to eq('eightway')
+    end
+
+  end
+
+end

data/spec/src/pretty-profanity/word_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe PrettyProfanity::Word do
+
+  before do
+    PrettyProfanity::Profanity.whitelist = ['hello world', 'goodbye hello']
+  end
+
+  subject { PrettyProfanity::Word.new('hello') }
+
+  describe '#to_regex' do
+
+    it 'matches the base hello' do
+      expect(subject.to_regex).to match('this is hello meow')
+    end
+
+    it 'matches the base HELLO in caps' do
+      expect(subject.to_regex).to match('this is HELLO meow')
+    end
+
+    it 'does not match beginning whitelist phrase' do
+      expect(subject.to_regex).to_not match('this is hello world meow')
+    end
+
+    it 'does not match ending whitelist phrase' do
+      expect(subject.to_regex).to_not match('this is goodbye hello meow')
+    end
+
+  end
+
+end

data/src/pretty-profanity.rb

@@ -0,0 +1,3 @@
+require_relative 'pretty-profanity/profanity'
+require_relative 'pretty-profanity/sanitize'
+require_relative 'pretty-profanity/word'

data/src/pretty-profanity/profanity.rb

@@ -0,0 +1,40 @@
+module PrettyProfanity
+
+  class Profanity
+
+    class << self
+
+      attr_accessor :whitelist, :blacklist, :replacement
+
+      def configure
+        yield(self)
+      end
+
+      def profane?(text)
+        text = text.to_s
+        !!blacklist.detect do |word|
+          true if text.match(Word.new(word).to_regex)
+        end
+      end
+
+      def sanitize(text)
+        text = text.to_s
+        cleanse = Sanitize.new
+        blacklist.each do |word|
+          text.gsub!(Word.new(word).to_regex, cleanse.send(replacement, word))
+        end
+        text
+      end
+
+      def offensive(text)
+        text = text.to_s
+        blacklist.select do |word|
+          true if text.match(Word.new(word).to_regex)
+        end
+      end
+
+    end
+
+  end
+
+end

data/src/pretty-profanity/sanitize.rb

@@ -0,0 +1,47 @@
+module PrettyProfanity
+
+  class Sanitize
+
+    def none(word)
+      ''
+    end
+
+    def vowels(word)
+      word.gsub(/[aeiou]/, '*')
+    end
+
+    def star(word)
+      '*' * word.length
+    end
+
+    def garbled(word)
+      text = '$@!#%'
+      word.length.times do |i|
+        word[i] = text[rand(0..(text.length-1))]
+      end
+      word
+    end
+
+    def hollow(word)
+      word[1,word.length-2] = '*' * (word.length - 2)
+      word
+    end
+
+    def L337(word)
+      letters = %w(4 B \( D 3 Ph 9 |-| 1 j |< L |V| |V 0 P Q R 5 7 U V VV >< '/ Z)
+      word.split('').map { |letter, index|
+        letters[letter.ord - 97]
+      }.join
+    end
+
+    def piglatin(word)
+      if word.match(/^[aeiou]/)
+        word + 'way'
+      else
+        word.gsub(/^([^aeiou]+)(.+)$/, '\2\1') + 'ay'
+      end
+    end
+
+  end
+
+end

data/src/pretty-profanity/word.rb

@@ -0,0 +1,32 @@
+module PrettyProfanity
+
+  class Word
+
+    attr_accessor :word, :whitelist
+
+    def initialize(word)
+      @word = word
+      @whitelist = Profanity.whitelist
+    end
+
+    def to_regex
+      /#{before_regex}\b(#{word})\b#{after_regex}/i
+    end
+
+    def before_regex
+      words = whitelist(/^#{word}/)
+      "(?!#{words.join('|')})" unless words.empty?
+    end
+
+    def after_regex
+      words = whitelist(/#{word}$/)
+      "(?<!#{words.join('|')})" unless words.empty?
+    end
+
+    def whitelist(word)
+      @whitelist.grep(word)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: pretty-profanity
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Blaine Schmeisser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-13 00:00:00.000000000 Z
+dependencies: []
+description: Cleans up profanity in text with blacklist, whitelists, and multiple
+  types of sanitization rules. Easily add new sanitization rules.
+email: blainesch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- pretty-profanity.gemspec
+- readme.md
+- spec/spec_helper.rb
+- spec/src/pretty-profanity/profanity_spec.rb
+- spec/src/pretty-profanity/sanitize_spec.rb
+- spec/src/pretty-profanity/word_spec.rb
+- src/pretty-profanity.rb
+- src/pretty-profanity/profanity.rb
+- src/pretty-profanity/sanitize.rb
+- src/pretty-profanity/word.rb
+homepage: https://github.com/blainesch/pretty-profanity.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- src
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Cleans up profanity in text.
+test_files: []