profanalyzer 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.2.0 / 2009-03-23
+
+* Added an options hash to Profanalyzer#filter and Profanalyzer#profane?, letting you change settings but only within the scope of that call - using this hash won't change the global settings.
+
 === 0.1.1 / 2009-03-22
 
 * Fixed the link to point to http://profanalyzer.rubyforge.org/

data/Manifest.txt

@@ -5,3 +5,4 @@ Rakefile
 config/list.yml
 lib/profanalyzer.rb
 test/test_profanalyzer.rb
+test/test_profanalyzer_advanced.rb

data/README.txt

@@ -4,22 +4,13 @@
 
 == 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.
+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:
 

data/Rakefile

@@ -8,6 +8,69 @@ Hoe.new('profanalyzer', Profanalyzer::VERSION) do |p|
   # p.rubyforge_name = 'profanalyzerx' # if different than lowercase project name
   p.developer('Michael J. Edgar', 'edgar@triqweb.com')
   p.remote_rdoc_dir = ''
+  
+  desc 'Post your blog announcement to blogger.'
+  task :post_blogger do
+    require 'net/http'
+    require 'net/https'
+    p.with_config do |config, path|
+      break unless config['blogs']
+      subject, title, body, urls = p.announcement
+      #body += "\n\n#{urls}"
+      
+      config['blogs'].each do |site|
+        next unless site['url'] =~ /www\.blogger\.com/
+        google_email = site['user']
+        google_passwd = site['password']
+        source = 'beforefilter.blogspot.com-rubypost'
+
+        http = Net::HTTP.new('www.google.com', 443)
+        http.use_ssl = true
+        login_url = '/accounts/ClientLogin'
+
+        # Setup HTTPS request post data to obtain authentication token.
+        data = 'Email=' + google_email +'&Passwd=' + google_passwd + '&source=' + source + '&service=blogger'
+        headers = {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+
+        # Submit HTTPS post request
+        resp, data = http.post(login_url, data, headers)
+
+        unless resp.code.eql? '200' 
+          puts "Error during authentication, blog at #{site['url']}, ##{site['blog_id']}: #{resp.message}\n"
+        else 
+
+          # Parse for the authentication token.
+          authToken = data.split("\n").map {|l| l.split("=")}.assoc("Auth")[1]
+
+          headers = {
+            'Authorization' => 'GoogleLogin auth=' + authToken,
+            'Content-Type' => 'application/atom+xml'
+          }
+
+          data = <<-EOF
+          <entry xmlns='http://www.w3.org/2005/Atom'>
+            <title type='text'>#{title}</title>
+            <content type='xhtml'>
+              <div xmlns="http://www.w3.org/1999/xhtml">
+                #{body}
+              </div>
+            </content>
+            #{p.blog_categories.inject("") {|acc,cat| acc + "<category scheme=\"http://www.blogger.com/atom/ns#\" term=\"#{cat}\" />\n"}}
+          </entry>
+          EOF
+          
+          http = Net::HTTP.new('www.blogger.com')
+          path = '/feeds/' + site['blog_id'] + '/posts/default'
+
+          resp, data = http.post(path, data, headers)
+          puts "Error while posting, blog at #{site['url']}, ##{site['blog_id']}: #{resp.message}" unless resp.code == 200
+          # Expect resp.code == 200 and resp.message == 'OK' for a successful.
+        end
+      end
+    end
+  end
 end
 
 # vim: syntax=Ruby

data/lib/profanalyzer.rb

@@ -98,7 +98,7 @@ require 'yaml'
 # SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 class Profanalyzer
   
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
   
   @@full_list = YAML::load_file(File.dirname(__FILE__)+"/../config/list.yml")
   @@racist_list = @@full_list.select {|w| w[:racist]}
@@ -125,6 +125,19 @@ class Profanalyzer
     banned_words
   end
   
+  def self.update_settings_from_hash(hash)
+    self.tolerance = hash[:tolerance] if hash.has_key? :tolerance
+    self.check_racist = hash[:racist] if hash.has_key? :racist
+    self.check_sexual = hash[:sexual] if hash.has_key? :sexual
+    if hash.has_key? :all
+      self.check_all = hash[:all]
+    elsif hash.has_key?(:sexual) || hash.has_key?(:racist)
+      self.check_all = false
+    else
+      self.check_all = true
+    end
+  end
+  
   # Decides whether the given string is profane, given Profanalyzer's current
   # settings. Examples:
   #    Profanalyzer.profane?("you're an asshole") #==> true
@@ -134,11 +147,30 @@ class Profanalyzer
   #    Profanalyzer.check_racist = false
   #    Profanalyzer.profane?("you're a mick") #==> false
   #
-  def self.profane?(str)
-    banned_words = Profanalyzer.forbidden_words_from_settings
+  # You can pass options to the method itself:
+  #    Profanalyzer.profane?("you're a mick", :racist => false) #==> false
+  #
+  # Available options:
+  # 
+  # [:+all+]     Set to +true+ or +false+ to specify checking all words in the blacklist
+  # [:+sexual+]  Set to +true+ or +false+ to specify sexual checking
+  # [:+racist+]  Set to +true+ or +false+ to specify racial slur checking
+  # [:+tolerance+] Sets the tolerance. 0-5.
+  #
+  def self.profane?(*args)
+    str = args[0]
+    if (args.size > 1 && args[1].is_a?(Hash))
+      oldsettings = @@settings
+      self.update_settings_from_hash args[1]
+    end
+    banned_words = self.forbidden_words_from_settings
     banned_words.each do |word|
-      return true if str =~ /#{word}/
+      if str =~ /#{word}/
+        @@settings = oldsettings if oldsettings
+        return true
+      end
     end
+    @@settings = oldsettings if oldsettings
     false
   end
   
@@ -153,7 +185,23 @@ class Profanalyzer
   #    Profanalyzer.filter("shit") #==> "shiat"
   #    Profanalyzer.filter("damn") #==> "#!$%"
   #
-  def self.filter(str)
+  # You can pass options to the method itself:
+  #    Profanalyzer.filter("you're a mick", :racist => false) #==> "you're a mick"
+  #
+  # Available options:
+  # 
+  # [:+all+]     Set to +true+ or +false+ to specify checking all words in the blacklist
+  # [:+sexual+]  Set to +true+ or +false+ to specify sexual checking
+  # [:+racist+]  Set to +true+ or +false+ to specify racial slur checking
+  # [:+tolerance+] Sets the tolerance. 0-5.
+  #
+  def self.filter(*args)
+    str = args[0]
+    if (args.size > 1 && args[1].is_a?(Hash))
+      oldsettings = @@settings
+      self.update_settings_from_hash args[1]
+    end
+    
     retstr = str
     
     @@settings[:custom_subs].each do |k,v|
@@ -165,6 +213,7 @@ class Profanalyzer
       retstr.gsub!(/#{word}/,
           "#!$%@&!$%@%@&!$#!$%@&!$%@%@&!#!$%@&!$%@%@&!"[0..(word.length-1)])
     end
+    @@settings = oldsettings if oldsettings
     retstr
   end
   

data/test/test_profanalyzer.rb

@@ -15,6 +15,7 @@ class TestProfanalyzer < Test::Unit::TestCase
     Profanalyzer.check_sexual = false
     Profanalyzer.check_racist = true
     assert_equal(true, Profanalyzer.profane?("spic"))
+    assert_equal(false, Profanalyzer.profane?("pussy"))
   end
   
   def test_single_sexual_word
@@ -23,6 +24,7 @@ class TestProfanalyzer < Test::Unit::TestCase
     Profanalyzer.check_racist = false
     Profanalyzer.check_sexual = true
     assert_equal(true, Profanalyzer.profane?("vagina"))
+    assert_equal(false, Profanalyzer.profane?("nigger"))
   end
   
   def test_tolerance

data/test/test_profanalyzer_advanced.rb

@@ -0,0 +1,53 @@
+require "test/unit"
+require "profanalyzer"
+
+class TestProfanalyzer < Test::Unit::TestCase
+  
+  def test_single_word_advanced
+    assert_equal(true, Profanalyzer.profane?("asshole", :tolerance => 0, :all => true))
+  end
+  
+  def test_single_racist_word_advanced
+    assert_equal(true, Profanalyzer.profane?("spic", :tolerance => 0, :racist => true, :sexual => false))
+    assert_equal(false, Profanalyzer.profane?("pussy", :tolerance => 0, :racist => true, :sexual => false))
+  end
+  
+  def test_single_sexual_word_advanced
+    assert_equal(true, Profanalyzer.profane?("vagina", :tolerance => 0, :racist => false, :sexual => true))
+    assert_equal(false, Profanalyzer.profane?("nigger", :tolerance => 0, :racist => false, :sexual => true))
+  end
+  
+  def test_tolerance_advanced
+    assert_equal(false, Profanalyzer.profane?("asskisser", :tolerance => 4, :all => true)) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("fuck", :tolerance => 4, :all => true))       # badness = 5
+  end
+  
+  def test_sexual_tolerance_advanced
+    assert_equal(false, Profanalyzer.profane?("vagina", :tolerance => 4, :racist => false, :sexual => true)) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("cunt", :tolerance => 4, :racist => false, :sexual => true))       # badness = 5
+  end
+  
+  def test_racist_tolerance_advanced
+    assert_equal(false, Profanalyzer.profane?("mick", :tolerance => 4, :racist => true, :sexual => false)) # badness = 3
+    assert_equal(true, Profanalyzer.profane?("nigger", :tolerance => 4, :racist => true, :sexual => false))       # badness = 5
+  end
+  
+  def test_filter_advanced
+    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, :tolerance => 0, :all => true))
+  end
+  
+  def test_sexual_filter_advanced
+    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, :tolerance => 0, :sexual => true, :racist => false))
+  end
+  
+  def test_racist_filter_advanced
+    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, :tolerance => 0, :sexual => false, :racist => true))
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: profanalyzer
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Michael J. Edgar
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-22 00:00:00 -04:00
+date: 2009-03-23 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !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."
+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: []
@@ -41,6 +41,7 @@ files:
 - config/list.yml
 - lib/profanalyzer.rb
 - test/test_profanalyzer.rb
+- test/test_profanalyzer_advanced.rb
 has_rdoc: true
 homepage: http://profanalyzer.rubyforge.org/
 post_install_message: 
@@ -70,3 +71,4 @@ specification_version: 2
 summary: "Profanalyzer has one purpose: analyze a block of text for profanity"
 test_files: 
 - test/test_profanalyzer.rb
+- test/test_profanalyzer_advanced.rb