obscenity-plus 1.0.1

data/lib/obscenity/active_model.rb

@@ -0,0 +1,19 @@
+#active_model.rb
+if defined?(ActiveModel)
+  module ActiveModel
+    module Validations
+      class ObscenityValidator < ActiveModel::EachValidator
+        
+        def validate_each(record, attribute, value)
+          if options.present? && options.has_key?(:sanitize)
+            object = record.respond_to?(:[]) ? record[attribute] : record.send(attribute)
+            object = Obscenity.replacement(options[:replacement]).sanitize(object)
+          else
+            record.errors.add(attribute, options[:message] || 'cannot be profane') if Obscenity.profane?(value)
+          end
+        end
+        
+      end
+    end
+  end
+end

data/lib/obscenity/base.rb

@@ -0,0 +1,75 @@
+#base.rb
+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|
+          return(true) if text =~ /\b#{foul}(?!\w)/i && !whitelist.include?(foul)
+        end
+        false
+      end
+
+      def sanitize(text)
+        return(text) unless text.to_s.size >= 3
+        blacklist.each do |foul|
+          text.gsub!(/\b#{foul}\b/i, replace(foul)) unless whitelist.include?(foul)
+        end
+        @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
+        blacklist.each do |foul|
+          words << foul if text =~ /\b#{foul}\b/i && !whitelist.include?(foul)
+        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
+        when Array then list
+        when String, Pathname then YAML.load_file( list.to_s )
+        else []
+        end
+      end
+
+    end
+  end
+end

data/lib/obscenity/config.rb

@@ -0,0 +1,51 @@
+module Obscenity
+  class Config
+    
+    attr_accessor :replacement
+    
+    DEFAULT_WHITELIST = []
+    DEFAULT_BLACKLIST = File.dirname(__FILE__) + "/../../config/blacklist.yml"
+    
+    def initialize
+      yield(self) if block_given?
+      validate_config_options
+    end
+    
+    def replacement
+      @replacement ||= :garbled
+    end
+    
+    def blacklist
+      @blacklist ||= DEFAULT_BLACKLIST
+    end
+    
+    def blacklist=(value)
+      @blacklist = value == :default ? DEFAULT_BLACKLIST : value
+    end
+    
+    def whitelist
+      @whitelist ||= DEFAULT_WHITELIST
+    end
+    
+    def whitelist=(value)
+      @whitelist = value == :default ? DEFAULT_WHITELIST : value
+    end
+    
+    private
+    def validate_config_options
+      [@blacklist, @whitelist].each{ |content| validate_list_content(content) if content }
+    end
+    
+    def validate_list_content(content)
+      case content
+      when Array    then !content.empty?       || raise(Obscenity::EmptyContentList.new('Content array is empty.'))
+      when String   then File.exist?(content) || raise(Obscenity::UnkownContentFile.new("Content file can't be found."))
+      when Pathname then content.exist?        || raise(Obscenity::UnkownContentFile.new("Content file can't be found."))
+      when Symbol   then content == :default   || raise(Obscenity::UnkownContent.new("The only accepted symbol is :default."))
+      else
+        raise Obscenity::UnkownContent.new("The content can be either an Array, Pathname, or String path to a .yml file.")
+      end
+    end
+    
+  end
+end

data/lib/obscenity/error.rb

@@ -0,0 +1,7 @@
+module Obscenity
+  class Error < RuntimeError; end
+  
+  class UnkownContent     < Error; end
+  class UnkownContentFile < Error; end
+  class EmptyContentList  < Error; end
+end

data/lib/obscenity/rack.rb

@@ -0,0 +1,89 @@
+module Rack
+  class Obscenity
+        
+    def initialize(app, options = {})  
+      @app, @options = app, options
+    end  
+    
+    def call(env)
+      rejectable  = false
+      post_params = Rack::Utils.parse_query(env['rack.input'].read, "&")
+      get_params  = Rack::Utils.parse_query(env['QUERY_STRING'],    "&")
+      
+      if @options.has_key?(:reject)
+        rejactable = validate_rejectability_of( select_params(:reject, get_params.update(post_params)) )
+      
+      elsif @options.has_key?(:sanitize)
+        get_params  = sanitize_contents_of(get_params)
+        post_params = sanitize_contents_of(post_params)
+        
+        env['QUERY_STRING'] = Rack::Utils.build_query(get_params)
+        env['rack.input']   = StringIO.new(Rack::Utils.build_query(post_params))
+      end
+      
+      rejactable ? reject : continue(env)
+    end
+    
+    private
+    def continue(env)
+      @app.call(env)
+    end
+    
+    def reject
+      length, content = 0, ''
+      if @options[:reject].is_a?(Hash) 
+        if (message = @options[:reject][:message]).present?
+          content = message
+          length  = message.size
+        elsif (path = @options[:reject][:path]).present?
+          if (path = ::File.expand_path(path)) && ::File.exists?(path)
+            content = ::File.read(path)
+            length  = content.size
+          end
+        end
+      end
+
+      [422, {'Content-Type' => 'text/html', 'Content-Length' => length.to_s}, [content]]
+    end
+
+    def validate_rejectability_of(params = {})
+      should_reject_request = false
+      params.each_pair do |param, value|
+        if value.is_a?(Hash)
+          validates_rejectability_of(value)
+        elsif value.is_a?(String)
+          next unless value.size >= 3
+          if ::Obscenity.profane?(value)
+            should_reject_request = true
+            break
+          end
+        else
+          next
+        end
+      end
+      should_reject_request
+    end
+        
+    def sanitize_contents_of(params)
+      sanitized_params   = {}
+      replacement_method = @options[:sanitize].is_a?(Hash) && @options[:sanitize][:replacement]
+      select_params(:sanitize, params).each{|param, value|
+        if value.is_a?(String)
+          next unless value.size >= 3
+          sanitized_params[param] = ::Obscenity.replacement(replacement_method).sanitize(value)
+        else
+          next
+        end
+      }
+      params.update(sanitized_params)
+    end
+    
+    def select_params(key, params = {})
+      if @options[key].is_a?(Hash) && @options[key][:params].is_a?(Array)
+        params.select{ |param, vvalue| @options[key][:params].include?(param.to_sym) } 
+      else
+        params
+      end
+    end
+  end
+end

data/lib/obscenity/rspec_matcher.rb

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

data/lib/obscenity/version.rb

@@ -0,0 +1,5 @@
+module Obscenity
+
+  VERSION = '1.0.2'
+  
+end

data/lib/obscenity.rb

@@ -0,0 +1,40 @@
+require 'obscenity/error'
+require 'obscenity/config'
+require 'obscenity/base'
+require 'obscenity/version'
+
+if defined?(::RSpec)
+  require 'obscenity/rspec_matcher'
+end
+
+module Obscenity extend self
+  
+  attr_accessor :config
+  
+  def configure(&block)
+    @config = Config.new(&block)
+  end
+  
+  def config
+    @config ||= Config.new
+  end
+  
+  def profane?(word)
+    Obscenity::Base.profane?(word)
+  end
+  
+  def sanitize(text)
+    Obscenity::Base.sanitize(text)
+  end
+  
+  def replacement(chars)
+    Obscenity::Base.replacement(chars)
+  end
+
+  def offensive(text)
+    Obscenity::Base.offensive(text)
+  end
+  
+  
+end
+  

data/test/helper.rb

@@ -0,0 +1,29 @@
+#helper.rb
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+# Load ActiveModel and Obscenity
+require 'active_model'
+require 'obscenity'
+require 'obscenity/active_model'
+
+# Dummy Model for Testing
+FactoryBot.define do
+  factory :base_model, class: Dummy::BaseModel do
+    title { "Sample title" }
+  end
+end
+
+# Configure RSpec
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+end

data/test/static/422.html

@@ -0,0 +1 @@
+We don't accept profanity

data/test/test_active_model.rb

@@ -0,0 +1,70 @@
+#test_active_model.rb
+require 'helper'
+
+class TestActiveModel < Test::Unit::TestCase
+  
+  def generate_new_class(name, options = {})
+    Dummy.send(:remove_const, name) if Dummy.const_defined?(name)
+    klass = Class.new(Dummy::BaseModel) do
+      validates :title, options
+    end
+    Dummy.const_set(name, klass)
+  end
+
+  should "be invalid when title is profane" do
+    klass = generate_new_class("Post", obscenity: true)
+    post  = klass.new(title: "He who poops, shits itself")
+    assert !post.valid?
+    assert post.errors.has_key?(:title)
+    assert_equal ['cannot be profane'], post.errors[:title]
+  end
+
+  should "be invalid when title is profane and should include a custom error message" do
+    klass = generate_new_class("Post", obscenity: { message: "can't be profane!" })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert !post.valid?
+    assert post.errors.has_key?(:title)
+    assert_equal ["can't be profane!"], post.errors[:title]
+  end
+
+  should "sanitize the title using the default replacement" do
+    klass = generate_new_class("Post", obscenity: { sanitize: true })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert post.valid?
+    assert !post.errors.has_key?(:title)
+    assert_equal "He who poops, $@!#% itself", post.title
+  end
+  
+  should "sanitize the title using the :garbled replacement" do
+    klass = generate_new_class("Post", obscenity: { sanitize: true, replacement: :garbled })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert post.valid?
+    assert !post.errors.has_key?(:title)
+    assert_equal "He who poops, $@!#% itself", post.title
+  end
+
+  should "sanitize the title using the :stars replacement" do
+    klass = generate_new_class("Post", obscenity: { sanitize: true, replacement: :stars })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert post.valid?
+    assert !post.errors.has_key?(:title)
+    assert_equal "He who poops, ***** itself", post.title
+  end
+
+  should "sanitize the title using the :vowels replacement" do
+    klass = generate_new_class("Post", obscenity: { sanitize: true, replacement: :vowels })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert post.valid?
+    assert !post.errors.has_key?(:title)
+    assert_equal "He who poops, sh*ts itself", post.title
+  end
+
+  should "sanitize the title using a custom replacement" do
+    klass = generate_new_class("Post", obscenity: { sanitize: true, replacement: '[censored]' })
+    post  = klass.new(title: "He who poops, shits itself")
+    assert post.valid?
+    assert !post.errors.has_key?(:title)
+    assert_equal "He who poops, [censored] itself", post.title
+  end
+
+end

data/test/test_base.rb

@@ -0,0 +1,29 @@
+# test_base.rb
+require 'test/unit'
+require 'obscenity'
+
+class TestObscenityBase < Test::Unit::TestCase
+  def setup
+    Obscenity.configure do |config|
+      config.blacklist = ["badword"]
+      config.whitelist = []
+      config.replacement = :stars
+    end
+  end
+
+  def test_methods_respond
+    [:blacklist, :whitelist, :profane?, :sanitize, :replacement, :offensive, :replace].each do |method|
+      assert_respond_to Obscenity::Base, method
+    end
+  end
+
+  def test_profane_detection
+    assert Obscenity::Base.profane?("badword")
+    assert !Obscenity::Base.profane?("cleanword")
+  end
+
+  def test_sanitization
+    assert_equal "*******", Obscenity::Base.sanitize("badword")
+    assert_equal "cleanword", Obscenity::Base.sanitize("cleanword")
+  end
+end

data/test/test_config.rb

@@ -0,0 +1,67 @@
+#test_config.rb
+require 'helper'
+
+class TestConfig < Test::Unit::TestCase
+
+  context "#respond_to?" do
+    should "respond to methods and attributes" do
+      Obscenity::Config.new do |config|
+        [:blacklist, :whitelist, :replacement].each do |field|
+          assert config.respond_to?(field)
+        end
+      end
+    end
+  end
+  
+  should "properly set the config parameters" do
+    blacklist   = ['ass', 'shit', 'penis']
+    whitelist   = ['penis']
+    replacement = :stars
+    
+    config = Obscenity::Config.new do |config|
+      config.blacklist   = blacklist
+      config.whitelist   = whitelist
+      config.replacement = replacement
+    end
+    
+    assert_equal blacklist, config.blacklist
+    assert_equal whitelist, config.whitelist
+    assert_equal replacement, config.replacement
+  end
+
+  should "return default values if none is set" do
+    config = Obscenity::Config.new
+    assert_equal [], config.whitelist
+    assert_equal :garbled, config.replacement
+    assert_match /config\/blacklist.yml/, config.blacklist
+  end
+
+  should "return default values when default values are set" do
+    config = Obscenity::Config.new do |config|
+      config.blacklist   = :default
+      config.replacement = :default
+    end
+    assert_equal [], config.whitelist
+    assert_equal :default, config.replacement
+    assert_match /config\/blacklist.yml/, config.blacklist
+  end
+  
+  should "properly validate the config options" do
+    [:blacklist, :whitelist].each do |field|
+      exceptions = [
+        [Obscenity::UnkownContent, {}], 
+        [Obscenity::UnkownContent, ":unkown"], 
+        [Obscenity::EmptyContentList, []], 
+        [Obscenity::UnkownContentFile, "'path/to/file'"], 
+        [Obscenity::UnkownContentFile, Pathname.new("'path/to/file'")]
+      ].each do |klass, value|
+        assert_raise(klass){
+          Obscenity::Config.new do |config|
+            config.instance_eval "config.#{field} = #{value}"
+          end
+        }
+      end
+    end
+  end
+  
+end

data/test/test_obscenity.rb

@@ -0,0 +1,70 @@
+#test_obscenity.rb
+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|
+        assert Obscenity.respond_to?(field)
+      end
+    end
+  end
+
+  # More comprehensive test in test_config.rb
+  context "#configure" do
+    should "accept a configuration block " do
+      assert_nothing_raised{
+        Obscenity.configure do |config|
+          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
+      assert Obscenity.profane?('Yo, check that ass out')
+      assert !Obscenity.profane?('Hello world')
+    end
+  end
+
+  # More comprehensive test in test_base.rb
+  context "#sanitize" do
+    should "sanitize the given content" do
+      assert_equal "Yo, check that $@!#% out", Obscenity.sanitize('Yo, check that ass out')
+      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
+      assert_equal ['ass', 'biatch'], Obscenity.offensive('Yo, check that ass biatch')
+      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