saintly 0.1.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.1 / 2010-06-30
+
+* starting point

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/saintly.rb
+rails/init.rb
+test/saintly_test.rb

data/README.txt

@@ -0,0 +1,59 @@
+= Saintly
+
+* http://www.bitbucket.org/digger250/saintly
+
+== DESCRIPTION:
+
+A library for censoring naughty words
+
+== FEATURES/PROBLEMS:
+
+* exclude partial matches
+* exclude whole words
+* list of allowed words
+
+== SYNOPSIS:
+
+Saintly.sanitize(dirty_text)
+=> "cleaned text"
+
+In an ActiveRecord model:
+sanctify :column1, :column2 ...
+
+You can add words or partials in your config/initializers like so:
+
+Saintly::RESTRICTED_PARTIALS << 'idiot'
+Saintly::ALLOWED_WORDS << 'dumbass'
+Saintly::RESTRICTED_WORDS << 'pansy'
+
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+* gem install saintly
+
+== LICENSE:
+
+(The MIT License)
+
+  Copyright (c) 2010 Justin Coyne
+
+  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.

data/Rakefile

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+
+require 'rake/clean'
+require 'rubygems'
+require 'hoe'
+require 'ruby-debug'
+CLEAN.include %w(**/*.orig)
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :hg
+
+Hoe.spec 'saintly' do
+  developer('Justin Coyne', 'jcoyne@justincoyne.com')
+  extra_dev_deps << %w(shoulda >=2.10.0) << %w(mocha >=0.9.8)
+end
+
+task :install =>:package do
+  $:<< 'lib'
+  require 'saintly'
+  debugger
+  puts `GEM_HOME=~/.gem/ruby/1.8 gem install pkg/saintly-#{Saintly::VERSION}.gem`
+end
+# vim: syntax=ruby
+#

data/lib/saintly.rb

@@ -0,0 +1,55 @@
+module Saintly
+  VERSION = "0.1.1"
+
+  def self.sanitize(text)
+    text.gsub(exclude_regex){|m| ALLOWED_WORDS.include?(m) ? m : '*' * m.length}
+  end
+  
+  private
+  
+  def self.exclude_regex
+    /\b(#{(RESTRICTED_WORDS + partials_regex_array).join('|')})\b/
+  end
+
+  def self.partials_regex_array
+    RESTRICTED_PARTIALS.map{|w| '\w*' + w + '\w*'}
+  end
+    
+  
+  ALLOWED_WORDS = [ 'glass', 'scunthorpe', 'assume', 'assumption', 'assassin', 'assassinate', 'shitake']
+  
+  
+  RESTRICTED_PARTIALS = [
+    'fuck',
+    'shit',
+    'ass',
+    'nigger',
+    'cunt'
+    ]
+    
+  RESTRICTED_WORDS = [
+    'twat'
+    ]
+    
+  module Rails
+    
+    def self.included(base)
+      base.extend ClassMethods
+
+    end
+    
+    module ClassMethods
+      def sanctify(*args)
+        options =  args.last.instance_of?(Hash) ? args.pop : {}
+        define_attribute_methods
+        
+        args.each do |col|
+          define_method (col.to_s+"_with_saintly").to_sym do
+              Saintly.sanitize(read_attribute(col))
+          end
+          alias_method_chain col, :saintly
+        end
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,2 @@
+require 'saintly'
+ActiveRecord::Base.send(:include, Saintly::Rails)

data/test/saintly_test.rb

@@ -0,0 +1,81 @@
+require 'rubygems'
+require "test/unit"
+require 'saintly'
+require 'shoulda'
+require 'mocha'
+require 'ruby-debug'
+
+class SaintlyTest < Test::Unit::TestCase
+  should "sanitize full word" do
+    assert_equal '****', Saintly.sanitize('fuck')
+    assert_equal '***', Saintly.sanitize('ass')
+    assert_equal '****', Saintly.sanitize('shit')
+    assert_equal '****', Saintly.sanitize('cunt')
+    assert_equal '****', Saintly.sanitize('twat')
+    assert_equal '******', Saintly.sanitize('nigger')
+    
+  end
+  should "sanitize partial words" do
+    assert_equal '*******', Saintly.sanitize('fucking')
+    assert_equal '*******', Saintly.sanitize('asshole')
+    assert_equal '********', Saintly.sanitize('shithead')
+    
+  end
+  
+  should "not sanitize allowed words" do
+    assert_equal 'shitake', Saintly.sanitize('shitake')
+
+    assert_equal 'assassin', Saintly.sanitize('assassin')
+    assert_equal 'assumption', Saintly.sanitize('assumption')
+    assert_equal 'assume', Saintly.sanitize('assume')
+    assert_equal 'glass', Saintly.sanitize('glass')
+    
+    assert_equal 'scunthorpe', Saintly.sanitize('scunthorpe')
+    assert_equal 'lightwater', Saintly.sanitize('lightwater')
+  end
+  
+  
+  class MockArModel
+    
+    def self.define_attribute_methods
+    end
+    def self.alias_method_chain(method, behavior)
+      alias_method (method.to_s + '_without_' + behavior.to_s).to_sym, method
+      alias_method method, (method.to_s + '_with_' + behavior.to_s).to_sym
+      
+    end
+    def body
+      read_attribute(:body)
+    end
+    
+    def title
+      read_attribute(:title)
+    end
+    
+    def read_attribute (col)
+      case col
+      when :body
+        'assassin ass fucking'
+      when :title
+        'typical shithead'
+      end
+    end
+    
+    include Saintly::Rails
+    sanctify :body, :title
+
+  end
+
+  
+  context "rails app" do
+    setup do
+      @m = MockArModel.new
+    end
+    
+    should "create new methods" do
+      assert_equal 'assassin ass fucking', @m.body_without_saintly
+      assert_equal 'assassin *** *******', @m.body
+    end
+  end
+    
+end      

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: saintly
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Justin Coyne
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id003
+description: A library for censoring naughty words
+email: 
+- jcoyne@justincoyne.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/saintly.rb
+- rails/init.rb
+- test/saintly_test.rb
+has_rdoc: true
+homepage: http://www.bitbucket.org/digger250/saintly
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: saintly
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A library for censoring naughty words
+test_files: []
+