profanalyzer 0.1.0

data/lib/profanalyzer.rb

@@ -0,0 +1,212 @@
+require 'yaml'
+# = profanalyzer
+# 
+# * FIX (url)
+# 
+# == DESCRIPTION:
+# 
+# Profanalyzer has one purpose: analyze a block of text for profanity. It is
+# able to filter profane words as well. 
+# 
+# What sets it slightly apart from other filters is that it classifies each 
+# blocked word as "profane", "racist", or "sexual" - although right now, each
+# word is considered "profane". It also rates each word on a scale from 0-5, 
+# which is based on my subjective opinion, as well as whether the word is 
+# commonly used in non-profane situations, such as "ass" in "assess".
+# 
+# The Profanalyzer will default to a tolerance of of 2, which will kick back
+# the arguably non-profane words. It will also test against all words,
+# including racist or sexual words.
+# 
+# Lastly, it allows for custom substitutions! For example, the filter at the
+# website http://www.fark.com/ turns the word "fuck" into "fark", and "shit"
+# into "shiat". You can specify these if you want.
+# 
+# == FEATURES/PROBLEMS:
+# 
+# * Tolerance-based filtering
+# * Switch between checking all words, racist terms, sexual words, or some 
+#   mixture
+# * Custom substitutions
+# * Boolean-based profanity checking (skipping the filtering)
+# 
+# == SYNOPSIS:
+# 
+# Out of the box, you can simply use Profanalyzer.filter and 
+# Profanalyzer.profane?:
+# 
+#    require 'rubygems'
+#    require 'profanalyzer'
+#    
+#    Profanalyzer.profane? "asshole" #==> true
+#    Profanalyzer.filter   "asshole" #==> "#!$%@&!"
+# 
+# Then you can change the tolerance:
+# 
+#    Profanalyzer.tolerance = 5
+#    Profanalyzer.profane? "hooker" #==> false
+# 
+# Or do specific checking:
+# 
+#    Profanalyzer.check_all = false # turn off catch-all checking
+#    Profanalyzer.check_racist = false # don't check racial slurs
+#    Profanalyzer.check_sexual = true # sexual checking on
+#    
+#    Profanalyzer.profane? "mick" #==> false
+#    Profanalyzer.profane? "vagina" #==> true
+# 
+# Lastly, you can add custom substitutions:
+# 
+#    Profanalyzer.substitute("shit","shiat")
+#    Profanalyzer.filter "shit" #==> "shiat"
+#    
+#    Profanalyzer.substitute(:fuck => :fark)
+#    Profanalyzer.filter("fuck") #==> "fark"
+# 
+# 
+# == REQUIREMENTS:
+# 
+# hoe - a gem for building gems, which I used for profanalyzer.
+# 
+# == INSTALL:
+# 
+# sudo gem install profanalyzer
+# 
+# == LICENSE:
+# 
+# (The MIT License)
+# 
+# Copyright (c) 2009 FIX
+# 
+# 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.
+class Profanalyzer
+  
+  VERSION = "0.1.0"
+  
+  @@full_list = YAML::load_file(File.dirname(__FILE__)+"/../config/list.yml")
+  @@racist_list = @@full_list.select {|w| w[:racist]}
+  @@sexual_list = @@full_list.select {|w| w[:sexual]}
+  
+  @@settings = {:racism => :forbidden, :sexual => :forbidden, :profane => :forbidden, :tolerance => 4, :custom_subs => {}}
+  
+  def self.forbidden_words_from_settings # :nodoc:
+    banned_words = []
+    
+    @@full_list.each do |word|
+      banned_words << word[:word] if @@settings[:tolerance] <= word[:badness]
+    end if @@settings[:profane] == :forbidden
+    
+    return banned_words if @@settings[:profane] == :forbidden #save some processing
+    
+    @@racist_list.each do |word|
+      banned_words << word[:word] if @@settings[:tolerance] <= word[:badness]
+    end if @@settings[:racism] == :forbidden
+    
+    @@sexual_list.each do |word|
+      banned_words << word[:word] if @@settings[:tolerance] <= word[:badness]
+    end if @@settings[:sexual] == :forbidden
+    banned_words
+  end
+  
+  # Decides whether the given string is profane, given Profanalyzer's current
+  # settings. Examples:
+  #    Profanalyzer.profane?("you're an asshole") #==> true
+  #
+  # With custom settings
+  #    Profanalyzer.check_all = false
+  #    Profanalyzer.check_racist = false
+  #    Profanalyzer.profane?("you're a mick") #==> false
+  #
+  def self.profane?(str)
+    banned_words = Profanalyzer.forbidden_words_from_settings
+    banned_words.each do |word|
+      return true if str =~ /#{word}/
+    end
+    false
+  end
+  
+  # Filters the provided string using the currently set rules, with #!@$%-like
+  # characters substituted in.
+  #
+  # Example:
+  #    Profanalyzer.filter("shit") #==> "#!$%"
+  #
+  # With Custom Substitutions:
+  #    Profanalyzer.substitute("shit","shiat")
+  #    Profanalyzer.filter("shit") #==> "shiat"
+  #    Profanalyzer.filter("damn") #==> "#!$%"
+  #
+  def self.filter(str)
+    retstr = str
+    
+    @@settings[:custom_subs].each do |k,v|
+      retstr.gsub!(/#{k.to_s}/,v.to_s)
+    end
+    
+    banned_words = Profanalyzer.forbidden_words_from_settings
+    banned_words.each do |word|
+      retstr.gsub!(/#{word}/,
+          "#!$%@&!$%@%@&!$#!$%@&!$%@%@&!#!$%@&!$%@%@&!"[0..(word.length-1)])
+    end
+    retstr
+  end
+  
+  # Sets Profanalyzer's tolerance. Value should be an integer such that 
+  # 0 <= T <= 5.
+  def self.tolerance=(new_tol)
+    @@settings[:tolerance] = new_tol
+  end
+  
+  # Sets Profanalyzer to scan (or not scan) for racist words, based on 
+  # the set tolerance.
+  # This is set to +true+ by default.
+  def self.check_racist=(check)
+    @@settings[:racism] = (check) ? :forbidden : :ignore
+  end
+  
+  # Sets Profanalyzer to scan (or not scan) for sexual words, based on the set tolerance.
+  # This is set to +true+ by default.
+  def self.check_sexual=(check)
+    @@settings[:sexual] = (check) ? :forbidden : :ignore
+  end
+  
+  # Sets Profanalyzer to scan (or not scan) for all profane words, based on the set tolerance.
+  # This is set to +true+ by default.
+  def self.check_all=(check)
+    @@settings[:profane] = (check) ? :forbidden : :ignore
+  end
+  
+  # Sets the list of substitutions to the hash passed in. Substitutions are
+  # performed such that +Profanalyzer.filter(key) = value+.
+  def self.subtitutions=(hash)
+    @@settings[:custom_subs] = hash
+  end
+  
+  # Sets a custom substitution for the filter.
+  # Can be passed as +substitute("foo","bar")+ or +"foo" => "bar"+
+  def self.substitute(*args)
+    case args[0]
+    when String
+      @@settings[:custom_subs].merge!(args[0] => args[1])
+    when Hash
+      @@settings[:custom_subs].merge!(args[0])
+    end
+  end
+end

data/test/test_profanalyzer.rb

@@ -0,0 +1,92 @@
+require "test/unit"
+require "profanalyzer"
+
+class TestProfanalyzer < Test::Unit::TestCase
+  
+  def test_single_word
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = true
+    assert_equal(true, Profanalyzer.profane?("asshole"))
+  end
+  
+  def test_single_racist_word
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = false
+    Profanalyzer.check_sexual = false
+    Profanalyzer.check_racist = true
+    assert_equal(true, Profanalyzer.profane?("spic"))
+  end
+  
+  def test_single_sexual_word
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = false
+    Profanalyzer.check_racist = false
+    Profanalyzer.check_sexual = true
+    assert_equal(true, Profanalyzer.profane?("vagina"))
+  end
+  
+  def test_tolerance
+    Profanalyzer.tolerance = 4
+    Profanalyzer.check_all = true
+    assert_equal(false, Profanalyzer.profane?("asskisser")) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("fuck"))       # badness = 5
+  end
+  
+  def test_sexual_tolerance
+    Profanalyzer.tolerance = 4
+    Profanalyzer.check_all = false
+    Profanalyzer.check_racist = false
+    Profanalyzer.check_sexual = true
+    assert_equal(false, Profanalyzer.profane?("vagina")) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("cunt"))       # badness = 5
+  end
+  
+  def test_racist_tolerance
+    Profanalyzer.tolerance = 4
+    Profanalyzer.check_all = false
+    Profanalyzer.check_sexual = false
+    Profanalyzer.check_racist = true
+    assert_equal(false, Profanalyzer.profane?("mick")) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("nigger"))       # badness = 5
+  end
+  
+  def test_filter
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = true
+    original_string = "You're a cocksucking piece of shit, you mick."
+    filtered_string = "You're a #!$%@&!$%@% piece of #!$%, you #!$%."
+    assert_equal(filtered_string, Profanalyzer.filter(original_string))
+  end
+  
+  def test_sexual_filter
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = false
+    Profanalyzer.check_sexual = true
+    Profanalyzer.check_racist = false
+    original_string = "You're a cocksucking piece of shit, you mick."
+    filtered_string = "You're a #!$%@&!$%@% piece of shit, you mick."
+    assert_equal(filtered_string, Profanalyzer.filter(original_string))
+  end
+  
+  def test_racist_filter
+    Profanalyzer.tolerance = 0
+    Profanalyzer.check_all = false
+    Profanalyzer.check_sexual = false
+    Profanalyzer.check_racist = true
+    original_string = "You're a cocksucking piece of shit, you mick."
+    filtered_string = "You're a cocksucking piece of shit, you #!$%."
+    assert_equal(filtered_string, Profanalyzer.filter(original_string))
+  end
+  
+  def test_subtitutions
+    Profanalyzer.substitute("shit","shiat")
+    assert_equal("shiat", Profanalyzer.filter("shit"))
+    
+    Profanalyzer.substitute("damn" => "darn")
+    assert_equal("darn", Profanalyzer.filter("damn"))
+    
+    Profanalyzer.substitute(:fuck => :fark)
+    assert_equal("fark", Profanalyzer.filter("fuck"))
+  end
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: profanalyzer
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael J. Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.11.0
+    version: 
+description: "Profanalyzer has one purpose: analyze a block of text for profanity. It is able to filter profane words as well.   What sets it slightly apart from other filters is that it classifies each  blocked word as \"profane\", \"racist\", or \"sexual\" - although right now, each word is considered \"profane\". It also rates each word on a scale from 0-5,  which is based on my subjective opinion, as well as whether the word is  commonly used in non-profane situations, such as \"ass\" in \"assess\".  The Profanalyzer will default to a tolerance of of 2, which will kick back the arguably non-profane words. It will also test against all words, including racist or sexual words.  Lastly, it allows for custom substitutions! For example, the filter at the website http://www.fark.com/ turns the word \"fuck\" into \"fark\", and \"shit\" into \"shiat\". You can specify these if you want."
+email: 
+- edgar@triqweb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- config/list.yml
+- lib/profanalyzer.rb
+- test/test_profanalyzer.rb
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: profanalyzer
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: "Profanalyzer has one purpose: analyze a block of text for profanity"
+test_files: 
+- test/test_profanalyzer.rb