obscenity 1.0.0 → 1.0.1

data/README.md

@@ -1,4 +1,4 @@
-# Obscenity [![Build Status](http://travis-ci.org/tjackiw/obscenity.png)](http://travis-ci.org/tjackiw/obscenity)
+# Obscenity [![Build Status](https://secure.travis-ci.org/tjackiw/obscenity.png)](http://travis-ci.org/tjackiw/obscenity)
 
 Obscenity is a profanity filter gem for Ruby/Rubinius, Rails (through ActiveModel), and Rack middleware.
 
@@ -52,6 +52,7 @@ The following methods are available to use with Obscenity:
 - :garbled        : Replaces profane words with $@!#%
 - :stars          : Replaces profane words with '*' up to the word's length
 - :vowels         : Replaces the vowels in the profane word with '*'
+- :nonconsonants  : Replaces non consonants with '*'
 - "custom string" : Replaces the profane word with the custom string
 
 Example:
@@ -101,6 +102,9 @@ Obscenity.replacement(:stars).sanitize("text with shit")
 Obscenity.replacement(:vowels).sanitize("text with shit")
 => "text with sh*t"
 
+Obscenity.replacement(:nonconsonants).sanitize('Oh 5hit')
+=> "Oh *h*t"
+
 Obscenity.replacement("[censored]").sanitize("text with shit")
 => "text with [censored]"
 ```
@@ -259,6 +263,17 @@ use Rack::Obscenity, sanitize: { params: [:foo, :bar], replacement: "[censored]"
 # Sanitizes all params and replaces their values using :garbled
 use Rack::Obscenity, sanitize: { replacement: :garbled }
 ```
+### Test Helpers
+
+Obscenity currently provides test helpers for RSpec only, but we have plans to add helpers to Shoulda as well.
+
+#### RSpec Matcher
+
+A `be_profane` matcher is available for RSpec. Its usage is very simple:
+
+```ruby
+user.username.should_not be_profane
+```
 
 ## Contributing to obscenity
  

data/lib/obscenity.rb

@@ -3,6 +3,10 @@ require 'obscenity/config'
 require 'obscenity/base'
 require 'obscenity/version'
 
+if defined?(::RSpec)
+  require 'obscenity/rspec_matcher'
+end
+
 module Obscenity extend self
   
   attr_accessor :config
@@ -33,4 +37,4 @@ module Obscenity extend self
   
   
 end
-  
+  

data/lib/obscenity/base.rb

@@ -1,23 +1,23 @@
 module Obscenity
   class Base
     class << self
-      
+
       def blacklist
         @blacklist ||= set_list_content(Obscenity.config.blacklist)
       end
-      
+
       def blacklist=(value)
         @blacklist = value == :default ? set_list_content(Obscenity::Config.new.blacklist) : value
       end
-      
+
       def whitelist
         @whitelist ||= set_list_content(Obscenity.config.whitelist)
       end
-      
+
       def whitelist=(value)
         @whitelist = value == :default ? set_list_content(Obscenity::Config.new.whitelist) : value
       end
-    
+
       def profane?(text)
         return(false) unless text.to_s.size >= 3
         blacklist.each do |foul|
@@ -25,7 +25,7 @@ module Obscenity
         end
         false
       end
-      
+
       def sanitize(text)
         return(text) unless text.to_s.size >= 3
         blacklist.each do |foul|
@@ -34,12 +34,12 @@ module Obscenity
         @scoped_replacement = nil
         text
       end
-      
+
       def replacement(chars)
         @scoped_replacement = chars
         self
       end
-      
+
       def offensive(text)
         words = []
         return(words) unless text.to_s.size >= 3
@@ -48,17 +48,18 @@ module Obscenity
         end
         words.uniq
       end
-      
+
       def replace(word)
         content = @scoped_replacement || Obscenity.config.replacement
         case content
         when :vowels then word.gsub(/[aeiou]/i, '*')
         when :stars  then '*' * word.size
+        when :nonconsonants then word.gsub(/[^bcdfghjklmnpqrstvwxyz]/i, '*')
         when :default, :garbled then '$@!#%'
         else content
         end
       end
-      
+
       private
       def set_list_content(list)
         case list
@@ -67,7 +68,7 @@ module Obscenity
         else []
         end
       end
-      
+
     end
   end
-end
+end

data/lib/obscenity/rspec_matcher.rb

@@ -0,0 +1,5 @@
+RSpec::Matchers.define :be_profane do |expected|
+  match do |actual|
+    Obscenity.profane?(actual) == expected
+  end
+end

data/lib/obscenity/version.rb

@@ -1,5 +1,5 @@
 module Obscenity
 
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
   
 end

data/obscenity.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "obscenity"
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Thiago Jackiw"]
-  s.date = "2012-05-28"
+  s.date = "2012-11-22"
   s.description = " Obscenity is a profanity filter gem for Ruby/Rubinius, Rails (through ActiveModel), and Rack middleware "
   s.email = "tjackiw@gmail.com"
   s.extra_rdoc_files = [
@@ -33,6 +33,7 @@ Gem::Specification.new do |s|
     "lib/obscenity/config.rb",
     "lib/obscenity/error.rb",
     "lib/obscenity/rack.rb",
+    "lib/obscenity/rspec_matcher.rb",
     "lib/obscenity/version.rb",
     "obscenity.gemspec",
     "test/helper.rb",

data/test/test_base.rb

@@ -25,7 +25,7 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#whitelist" do
     context "without custom config" do
       setup { Obscenity::Base.whitelist = :default }
@@ -41,11 +41,11 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#profane?" do
     context "without whitelist" do
       context "without custom config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = :default
         }
@@ -66,7 +66,7 @@ class TestBase < Test::Unit::TestCase
     end
     context "with whitelist" do
       context "without custom blacklist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -77,7 +77,7 @@ class TestBase < Test::Unit::TestCase
         end
       end
       context "with custom blacklist/whitelist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = ['ass', 'word']
           Obscenity::Base.whitelist = ['word']
         }
@@ -89,11 +89,11 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#sanitize" do
     context "without whitelist" do
       context "without custom config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = :default
         }
@@ -112,7 +112,7 @@ class TestBase < Test::Unit::TestCase
     end
     context "with whitelist" do
       context "without custom blacklist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -122,7 +122,7 @@ class TestBase < Test::Unit::TestCase
         end
       end
       context "with custom blacklist/whitelist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = ['clown', 'biatch']
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -133,11 +133,11 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#replacement" do
     context "without whitelist" do
       context "without custom config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = :default
         }
@@ -145,16 +145,18 @@ class TestBase < Test::Unit::TestCase
           assert_equal "Yo ********, sup", Obscenity::Base.replacement(:stars).sanitize('Yo assclown, sup')
           assert_equal "Yo $@!#%, sup", Obscenity::Base.replacement(:garbled).sanitize('Yo assclown, sup')
           assert_equal "Yo *sscl*wn, sup", Obscenity::Base.replacement(:vowels).sanitize('Yo assclown, sup')
+          assert_equal "Oh, *h*t!", Obscenity::Base.replacement(:nonconsonants).sanitize('Oh, 5hit!')
           assert_equal "Yo [censored], sup", Obscenity::Base.replacement('[censored]').sanitize('Yo assclown, sup')
           assert_equal "Hello World", Obscenity::Base.replacement(:default).sanitize('Hello World')
         end
       end
       context "with custom blacklist config" do
-        setup { Obscenity::Base.blacklist = ['ass', 'word'] }
+        setup { Obscenity::Base.blacklist = ['ass', 'word', 'w0rd'] }
         should "sanitize and return a clean text based on a custom list" do
           assert_equal "Yo ****, sup", Obscenity::Base.replacement(:stars).sanitize('Yo word, sup')
           assert_equal "Yo $@!#%, sup", Obscenity::Base.replacement(:garbled).sanitize('Yo word, sup')
           assert_equal "Yo w*rd, sup", Obscenity::Base.replacement(:vowels).sanitize('Yo word, sup')
+          assert_equal "Yo w*rd, sup", Obscenity::Base.replacement(:nonconsonants).sanitize('Yo w0rd, sup')
           assert_equal "Yo [censored], sup", Obscenity::Base.replacement('[censored]').sanitize('Yo word, sup')
           assert_equal "Hello World", Obscenity::Base.replacement(:default).sanitize('Hello World')
         end
@@ -162,7 +164,7 @@ class TestBase < Test::Unit::TestCase
     end
     context "with whitelist" do
       context "without custom blacklist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -170,12 +172,13 @@ class TestBase < Test::Unit::TestCase
           assert_equal "Yo ********, sup", Obscenity::Base.replacement(:stars).sanitize('Yo assclown, sup')
           assert_equal "Yo $@!#%, sup", Obscenity::Base.replacement(:garbled).sanitize('Yo assclown, sup')
           assert_equal "Yo *sscl*wn, sup", Obscenity::Base.replacement(:vowels).sanitize('Yo assclown, sup')
+          assert_equal "What an *r**", Obscenity::Base.replacement(:nonconsonants).sanitize('What an ar5e')
           assert_equal "Yo [censored], sup", Obscenity::Base.replacement('[censored]').sanitize('Yo assclown, sup')
           assert_equal "Yo biatch, sup", Obscenity::Base.replacement(:default).sanitize('Yo biatch, sup')
         end
       end
       context "with custom blacklist/whitelist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = ['clown', 'biatch']
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -183,6 +186,7 @@ class TestBase < Test::Unit::TestCase
           assert_equal "Yo *****, sup", Obscenity::Base.replacement(:stars).sanitize('Yo clown, sup')
           assert_equal "Yo $@!#%, sup", Obscenity::Base.replacement(:garbled).sanitize('Yo clown, sup')
           assert_equal "Yo cl*wn, sup", Obscenity::Base.replacement(:vowels).sanitize('Yo clown, sup')
+          assert_equal "Yo cl*wn, sup", Obscenity::Base.replacement(:nonconsonants).sanitize('Yo clown, sup')
           assert_equal "Yo [censored], sup", Obscenity::Base.replacement('[censored]').sanitize('Yo clown, sup')
           assert_equal "Yo biatch, sup", Obscenity::Base.replacement(:default).sanitize('Yo biatch, sup')
           assert_equal "Yo assclown, sup", Obscenity::Base.replacement(:default).sanitize('Yo assclown, sup')
@@ -190,11 +194,11 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#offensive" do
     context "without whitelist" do
       context "without custom config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = :default
         }
@@ -213,7 +217,7 @@ class TestBase < Test::Unit::TestCase
     end
     context "with whitelist" do
       context "without custom blacklist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = :default
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -223,7 +227,7 @@ class TestBase < Test::Unit::TestCase
         end
       end
       context "with custom blacklist/whitelist config" do
-        setup { 
+        setup {
           Obscenity::Base.blacklist = ['clown', 'biatch']
           Obscenity::Base.whitelist = ['biatch']
         }
@@ -234,20 +238,21 @@ class TestBase < Test::Unit::TestCase
       end
     end
   end
-  
+
   context "#replace" do
     should "replace the given word by the given replacement method" do
       [
-        [:vowels,  {original: "Yo biatch", clean: "Yo b**tch"}],
-        [:stars,   {original: "Yo biatch", clean: "Yo ******"}],
-        [:garbled, {original: "Yo biatch", clean: "Yo $@!#%"}],
-        [:default, {original: "Yo biatch", clean: "Yo $@!#%"}],
-        ["[censored]", {original: "Yo biatch", clean: "Yo [censored]"}],
-        [nil, {original: "Yo biatch", clean: "Yo $@!#%"}]
+        [:vowels,        {original: "Oh 5hit", clean: "Oh 5h*t"}],
+        [:nonconsonants, {original: "Oh 5hit", clean: "Oh *h*t"}],
+        [:stars,         {original: "Oh 5hit", clean: "Oh ****"}],
+        [:garbled,       {original: "Oh 5hit", clean: "Oh $@!#%"}],
+        [:default,       {original: "Oh 5hit", clean: "Oh $@!#%"}],
+        ["[censored]",   {original: "Oh 5hit", clean: "Oh [censored]"}],
+        [nil,            {original: "Oh 5hit", clean: "Oh $@!#%"}]
       ].each do |replacement_method, content|
-        assert_equal content[:clean], Obscenity::Base.replacement(replacement_method).sanitize(content[:original])
+        assert_equal content[:clean], Obscenity::Base.replacement(replacement_method).sanitize(content[:original]), "(replacement should match for #{replacement_method})"
       end
     end
   end
-  
+
 end

data/test/test_obscenity.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestObscenity < Test::Unit::TestCase
-  
+
   context "#respond_to?" do
     should "respond to methods and attributes" do
       [:configure, :config, :profane?, :sanitize, :offensive, :replacement].each do |field|
@@ -9,7 +9,7 @@ class TestObscenity < Test::Unit::TestCase
       end
     end
   end
-  
+
   # More comprehensive test in test_config.rb
   context "#configure" do
     should "accept a configuration block " do
@@ -18,17 +18,17 @@ class TestObscenity < Test::Unit::TestCase
           config.blacklist   = :default
           config.replacement = :garbled
         end
-      }      
+      }
     end
   end
-  
+
   # More comprehensive test in test_config.rb
   context "#config" do
     should "return the current config object" do
       assert_not_nil Obscenity.config
     end
   end
-  
+
   # More comprehensive test in test_base.rb
   context "#profane?" do
     should "validate the profanity of the given content" do
@@ -36,7 +36,7 @@ class TestObscenity < Test::Unit::TestCase
       assert !Obscenity.profane?('Hello world')
     end
   end
-  
+
   # More comprehensive test in test_base.rb
   context "#sanitize" do
     should "sanitize the given content" do
@@ -44,7 +44,7 @@ class TestObscenity < Test::Unit::TestCase
       assert_equal "Hello world", Obscenity.sanitize('Hello world')
     end
   end
-  
+
   # More comprehensive test in test_base.rb
   context "#offensive" do
     should "return the offensive words for the given content" do
@@ -52,17 +52,18 @@ class TestObscenity < Test::Unit::TestCase
       assert_equal [], Obscenity.offensive('Hello world')
     end
   end
-  
+
   # More comprehensive test in test_base.rb
   context "#replacement" do
     should "sanitize the given content based on the given replacement" do
       assert_equal "Yo, check that $@!#% out", Obscenity.replacement(:garbled).sanitize('Yo, check that ass out')
       assert_equal "Yo, check that $@!#% out", Obscenity.replacement(:default).sanitize('Yo, check that ass out')
       assert_equal "Yo, check that *ss out", Obscenity.replacement(:vowels).sanitize('Yo, check that ass out')
+      assert_equal "Yo, check that *h*t out", Obscenity.replacement(:nonconsonants).sanitize('Yo, check that 5hit out')
       assert_equal "Yo, check that *** out", Obscenity.replacement(:stars).sanitize('Yo, check that ass out')
       assert_equal "Yo, check that [censored] out", Obscenity.replacement("[censored]").sanitize('Yo, check that ass out')
       assert_equal "Hello world", Obscenity.sanitize('Hello world')
     end
   end
-  
+
 end

data/test/test_rack.rb

@@ -3,7 +3,7 @@ require 'rack/mock'
 require 'obscenity/rack'
 
 class TestRack < Test::Unit::TestCase
-  
+
   context "Rack::Obscenity" do
     setup do
       @env     = {}
@@ -12,37 +12,37 @@ class TestRack < Test::Unit::TestCase
       @headers = { 'Content-Type' => 'text/plain' }
       @app     = lambda { |env| [@status, @headers, [@body]] }
     end
-    
+
     def mock_env(options = {})
       @env = Rack::MockRequest.env_for('/', options)
     end
-    
+
     def middleware(options = {})
       Rack::Obscenity.new(@app, options)
     end
-    
+
     def get(params = {})
       { 'QUERY_STRING' => Rack::Utils.build_query(params) }
     end
-    
+
     def get_response_params
       Rack::Utils.parse_query(@env['QUERY_STRING'], "&")
     end
-    
+
     def post(params = {})
       { 'rack.input' => StringIO.new(Rack::Utils.build_query(params)) }
     end
-    
+
     def post_response_params
       Rack::Utils.parse_query(@env['rack.input'].read, "&")
     end
-    
+
     def assert_success_response(status, headers, body)
       assert_equal @status, status
       assert_equal @headers, headers
       assert_equal [@body], body
     end
-    
+
     context "default configuration" do
       should "not evaluate the profanity of parameters" do
         app = middleware
@@ -50,7 +50,7 @@ class TestRack < Test::Unit::TestCase
         assert_success_response status, headers, body
       end
     end
-    
+
     context "rejecting requests" do
       should "not reject if parameter values don't contain profanity" do
         app = middleware(reject: true)
@@ -74,7 +74,7 @@ class TestRack < Test::Unit::TestCase
 
       should "reject if given parameter values contain profanity" do
         app = middleware(reject: { params: [:foo] })
-        [ get(foo: 'ass', baz: 'shit'), 
+        [ get(foo: 'ass', baz: 'shit'),
           post(foo: 'ass').merge(get(foo: 'nice', baz: 'shit'))
         ].each do |options|
           status, headers, body = app.call(mock_env(options))
@@ -117,7 +117,7 @@ class TestRack < Test::Unit::TestCase
         assert_equal [''], body
       end
     end
-    
+
     context "sanitizing requests" do
       should "not sanitize if parameter values don't contain profanity" do
         app = middleware(sanitize: true)
@@ -135,7 +135,7 @@ class TestRack < Test::Unit::TestCase
         assert_equal 'bar', request_params['foo']
         assert_equal '$@!#%', request_params['baz']
       end
-      
+
       should "sanitize if POST parameter values contain profanity" do
         app = middleware(sanitize: true)
         status, headers, body = app.call(mock_env(post(foo: 'bar', baz: 'ass')))
@@ -161,7 +161,7 @@ class TestRack < Test::Unit::TestCase
         request_params = get_response_params
         assert_equal '$@!#%', request_params['foo']
       end
-      
+
       should "sanitize the title using the :garbled replacement" do
         app = middleware(sanitize: { replacement: :garbled })
         status, headers, body = app.call(mock_env(get(foo: 'ass')))
@@ -186,6 +186,14 @@ class TestRack < Test::Unit::TestCase
         assert_equal '*ss', request_params['foo']
       end
 
+      should "sanitize the title using the :nonconsonants replacement" do
+        app = middleware(sanitize: { replacement: :nonconsonants })
+        status, headers, body = app.call(mock_env(get(foo: '5hit')))
+        assert_success_response status, headers, body
+        request_params = get_response_params
+        assert_equal '*h*t', request_params['foo']
+      end
+
       should "sanitize the title using a custom replacement" do
         app = middleware(sanitize: { replacement: "[censored]" })
         status, headers, body = app.call(mock_env(get(foo: 'text with ass')))

data/test/test_version.rb

@@ -3,7 +3,7 @@ require 'helper'
 class TestVersion < Test::Unit::TestCase
 
   should "return the correct product version" do
-    assert_equal '1.0.0', Obscenity::VERSION
+    assert_equal '1.0.1', Obscenity::VERSION
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: obscenity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2012-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -148,6 +148,7 @@ files:
 - lib/obscenity/config.rb
 - lib/obscenity/error.rb
 - lib/obscenity/rack.rb
+- lib/obscenity/rspec_matcher.rb
 - lib/obscenity/version.rb
 - obscenity.gemspec
 - test/helper.rb
@@ -173,7 +174,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1086749465327118202
+      hash: -2450424540235026340
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: