validates_not_profane 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Michael J. Edgar
+
+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/README.md

@@ -0,0 +1,64 @@
+# validates_not_profane
+
+This is a fork of Michael Edgar's [validates\_not\_profane](https://github.com/michaeledgar/validates_not_profane)
+plugin, updated to a Rails 3 style validator gem.
+
+## Description
+
+validates_not_profane provides a hook into the Profanalyzer gem as a validation
+for your ActiveRecord models. It's use is simple:
+
+    validates_not_profane :column_name, :column_2
+
+Will cause the model to produce errors if that column contains profanity
+in its value. Of course, since the Profanalyzer gem is customizable, so is
+the validation:
+
+    validates_not_profane :post_title, :racist => true, :sexual => false
+
+will block racial slurs, but nothing else.
+
+    validates_not_profane :post_title, :tolerance => 5
+
+will block only the most vile of profanity. The scale for tolerance is
+from 0-5, which is mostly subjective, in all honesty.
+
+## Features/Problems
+
+* Tolerance-based profanity checking
+* Switch between checking all words, racist terms, sexual words, or some mixture
+* Custom substitutions
+* Boolean-based profanity checking
+
+## Install (with bundler)
+
+In your Gemfile:
+
+    gem 'validates_not_profane', :git => "git@github.com:akqa/validates_not_profane.git"
+
+Then run `bundle install`
+
+## License
+
+    (The MIT License)
+
+    Copyright (c) 2009 Michael J. Edgar
+
+    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 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the validates_not_profane plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the validates_not_profane plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ValidatesNotProfane'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/validates_not_profane.rb

@@ -0,0 +1,65 @@
+require 'active_model'
+require 'profanalyzer'
+
+module ActiveModel
+  module Validations
+    class ProfanityValidator < ActiveModel::EachValidator
+      DEFAULT_TOLERANCE = 2
+
+      def initialize(options)
+        super(options.reverse_merge(:message => "contains profanity"))
+      end
+
+      def validate_each(record, attribute, value)
+        if options.has_key?(:tolerance)
+          Profanalyzer.tolerance = options[:tolerance]
+        else
+          Profanalyzer.tolerance = DEFAULT_TOLERANCE
+        end
+
+        if options[:all]
+          Profanalyzer.check_all    = true
+        elsif options[:sexual] && options[:racist]
+          Profanalyzer.check_all    = false
+          Profanalyzer.check_sexual = true
+          Profanalyzer.check_racist = true
+        elsif options[:sexual]
+          Profanalyzer.check_all    = false
+          Profanalyzer.check_sexual = true
+          Profanalyzer.check_racist = false
+        elsif options[:racist]
+          Profanalyzer.check_all    = false
+          Profanalyzer.check_sexual = false
+          Profanalyzer.check_racist = true
+        else
+          Profanalyzer.check_all    = true
+        end
+
+        if Profanalyzer.profane?(value)
+          record.errors.add(attribute, :profane, options)
+        end
+      end
+    end
+
+    module HelperMethods
+      # Validates whether the value of the specified attributes contain
+      # profanity
+      #
+      #   class Comment < ActiveRecord::Base
+      #     validates_not_profane :body
+      #   end
+      #
+      # Configuration options:
+      # * <tt>:message</tt> - A custom error message (default is: "must not contain any vulgar words").
+      # * <tt>:tolerance</tt> - Tolerance for Profanalyzer
+      # * <tt>:sexual</tt> - Whether to check for sexual words
+      # * <tt>:racist</tt> - Whether to check for racial slurs
+      # * <tt>:all</tt> - Whether to check all bad words
+      def validates_not_profane(*attr_names)
+        validates_with ProfanityValidator, _merge_attributes(attr_names)
+      end
+    end
+
+  end
+end
+

data/lib/validates_not_profane/version.rb

@@ -0,0 +1,3 @@
+module ValidatesNotProfane
+  VERSION = "1.0.0"
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'validates_not_profane'
+require 'test/unit'
+
+class Model
+  include ActiveModel::Validations
+  def initialize(atts)
+    atts.each { |k,v| send("#{k}=", v) }
+  end
+end
+
+class User < Model
+  attr_accessor :name, :bio
+
+  validates_not_profane :name
+  validates_not_profane :bio, :tolerance => 5
+end
+
+class Post < Model
+  attr_accessor :subject, :post
+
+  validates_not_profane :subject, :racist => true
+  validates_not_profane :post,    :sexual => true
+end
+
+class Test::Unit::TestCase
+  def assert_valid(record)
+    assert_block { record.valid? }
+  end
+
+  def assert_invalid(record)
+    assert_block { !record.valid? }
+  end
+end

data/test/validates_not_profane_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper.rb'
+
+class ValidatesNotProfaneTest < Test::Unit::TestCase
+
+  def test_basic_blocks_profane
+    u = User.new(:name => "fucker")
+    assert_invalid(u)
+  end
+
+  def test_basic_allows_clean
+    u = User.new(:name => "Steve")
+    assert_valid(u)
+  end
+
+  def test_tolerance_blocks
+    u = User.new(:bio => "fucking prick") # badness = 5
+    assert_invalid(u)
+  end
+
+  def test_tolerance_allows
+    u = User.new(:bio => "queef") # badness = 4
+    assert_valid(u)
+  end
+
+  def test_racist_blocks
+    u = Post.new(:subject => "mick")
+    assert_invalid(u)
+  end
+
+  def test_racist_allows_others
+    u = Post.new(:subject => "fucker")
+    assert_valid(u)
+  end
+
+  def test_sexual_blocks
+    u = Post.new(:post => "cocksucker")
+    assert_invalid(u)
+  end
+
+  def test_sexual_allows_others
+    u = Post.new(:post => "mick") # again, I'm Irish
+    assert_valid(u)
+  end
+
+  def test_default_message
+    u = User.new(:name => "fucker")
+    assert_invalid(u)
+    assert_equal ["contains profanity"], u.errors[:name]
+  end
+
+  class CustomUser < Model
+    attr_accessor :name
+    validates_not_profane :name, :message => "Sorry, can't say that!"
+  end
+
+  def test_custom_message
+    u = CustomUser.new(:name => "fucker")
+    assert_invalid(u)
+    assert_equal ["Sorry, can't say that!"], u.errors[:name]
+  end
+end

data/validates_not_profane.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "validates_not_profane/version"
+
+Gem::Specification.new do |s|
+  s.name        = "validates_not_profane"
+  s.version     = ValidatesNotProfane::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ben Marini", "Michael j. Edgar"]
+  s.email       = ["bmarini@gmail.com"]
+  s.homepage    = "http://github.com/akqa/validates_not_profane"
+  s.summary     = %q{Rails 3 profanity validator for active model}
+  s.description = %q{Rails 3 profanity validator for active model}
+
+  s.rubyforge_project = "validates_not_profane"
+
+  s.add_dependency "profanalyzer", "~> 1.0"
+  s.add_dependency "activemodel", "~> 3.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: validates_not_profane
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Marini
+- Michael j. Edgar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: profanalyzer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+description: Rails 3 profanity validator for active model
+email: 
+- bmarini@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/validates_not_profane.rb
+- lib/validates_not_profane/version.rb
+- test/test_helper.rb
+- test/validates_not_profane_test.rb
+- validates_not_profane.gemspec
+has_rdoc: true
+homepage: http://github.com/akqa/validates_not_profane
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: validates_not_profane
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 profanity validator for active model
+test_files: 
+- test/test_helper.rb
+- test/validates_not_profane_test.rb