mr_clean 0.1.0 → 0.1.1

data/lib/mr_clean/config.rb

@@ -0,0 +1,12 @@
+require 'yaml'
+
+module MrClean
+  module Config
+    module_function
+
+    def hashify(file)
+      list = YAML::load(File.open(File.expand_path("../../config/#{file}", File.dirname(__FILE__))))
+      list.inject({}) { |memo, word| memo[word] = true; memo }
+    end
+  end
+end

data/lib/mr_clean/filter.rb

@@ -0,0 +1,17 @@
+module MrClean
+  module Filter
+    module_function
+
+    NON_WORDS = /(?!\s|-)\W|\d|_/
+    ONE_SPACE_STRING = ' '
+    EMPTY_STRING = ''
+
+    def clean(text)
+      text.downcase.gsub(NON_WORDS, EMPTY_STRING)
+    end
+
+    def slice(text)
+      clean(text).split(ONE_SPACE_STRING)
+    end
+  end
+end

data/lib/mr_clean/profanity.rb

@@ -0,0 +1,11 @@
+module MrClean
+  module Profanity
+    module_function
+
+    BAD_WORDS = MrClean::Config.hashify('bad_words.yml')
+
+    def profane?(text)
+      text && MrClean::Filter.slice(text).any? { |word| BAD_WORDS[word] }
+    end
+  end
+end

data/lib/mr_clean/version.rb

@@ -1,3 +1,3 @@
 module MrClean
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/mr_clean.rb

@@ -1,2 +1,6 @@
+%w(config filter profanity).each do |filename|
+  require File.expand_path File.dirname(__FILE__) + "/mr_clean/#{filename}.rb"
+end
+
 module MrClean
 end

data/mr_clean.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.name        = 'mr_clean'
   s.version     = MrClean::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = 'CrunchBase'
+  s.authors     = 'CrunchBase Engineering Team, Wagner Camarao'
   s.email       = 'engineering@crunchbase.com'
   s.summary     = 'A plain ruby library for filtering profanity, spam and such based on black listed words'
 
@@ -16,6 +16,16 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  #bench
+  s.add_development_dependency 'activesupport', '~> 4.0.0'
+  s.add_development_dependency 'obscenity', '~> 1.0.2'
+  s.add_development_dependency 'parallel', '~> 0.8.0'
+  s.add_development_dependency 'profanity_filter', '~> 0.1.1'
+
+  #test
+  s.add_development_dependency 'debugger', '~> 1.6.1'
+  s.add_development_dependency 'guard-rspec', '~> 3.0.3'
+  s.add_development_dependency 'pry-rails', '~> 0.3.2'
+  s.add_development_dependency 'rake', '~> 10.1.0'
+  s.add_development_dependency 'rspec', '~> 2.14.1'
 end

data/spec/mr_clean/config_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe MrClean::Config do
+  it 'loads a given config file out into a hash map' do
+    list = YAML::load(File.open(File.expand_path('../../config/bad_words.yml', File.dirname(__FILE__))))
+    hash = list.inject({}) { |memo, word| memo[word] = true; memo }
+    MrClean::Config.hashify('bad_words.yml').should == hash
+  end
+end

data/spec/mr_clean/filter_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe MrClean::Filter do
+  describe 'clean' do
+    it 'cleans a string keeping only letters and dashes, downcased' do
+      MrClean::Filter.clean('!@\'_foo"123-bar{[(.)]};').should == 'foo-bar'
+    end
+  end
+
+  describe 'slice' do
+    it 'cleans and slices a string into an array of words' do
+      MrClean::Filter.slice('foo! bar?').should == %w(foo bar)
+    end
+  end
+end

data/spec/mr_clean/profanity_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe MrClean::Profanity do
+  describe 'config' do
+    it 'builds a constant hash of bad words' do
+      list = YAML::load(File.open(File.expand_path('../../config/bad_words.yml', File.dirname(__FILE__))))
+      hash = list.inject({}) { |memo, word| memo[word] = true; memo }
+      MrClean::Profanity::BAD_WORDS.should == hash
+    end
+  end
+
+  describe 'filter' do
+    it 'knows whether a sentence is profane' do
+      MrClean::Profanity.profane?('Funky shit').should be_true
+    end
+
+    it 'knows whether a sentence is not profane' do
+      MrClean::Profanity.profane?('Hello there').should be_false
+    end
+
+    it 'considers a nil value to be not profane' do
+      MrClean::Profanity.profane?(nil).should be_false
+    end
+  end
+end

metadata

@@ -1,43 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: mr_clean
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
-- CrunchBase
+- CrunchBase Engineering Team, Wagner Camarao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-09 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: obscenity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: profanity_filter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 description: 
 email: engineering@crunchbase.com
 executables: []
@@ -46,12 +144,27 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- Gemfile
+- Gemfile.lock
 - Guardfile
 - README.md
 - Rakefile
+- bench/bench.rb
+- bench/mr_clean.rb
+- bench/obscenity.rb
+- bench/parallel.rb
+- bench/profanity_filter.rb
+- bench/samples.yml
+- config/bad_words.yml
 - lib/mr_clean.rb
+- lib/mr_clean/config.rb
+- lib/mr_clean/filter.rb
+- lib/mr_clean/profanity.rb
 - lib/mr_clean/version.rb
 - mr_clean.gemspec
+- spec/mr_clean/config_spec.rb
+- spec/mr_clean/filter_spec.rb
+- spec/mr_clean/profanity_spec.rb
 - spec/spec_helper.rb
 homepage: 
 licenses: []
@@ -72,11 +185,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A plain ruby library for filtering profanity, spam and such based on black
   listed words
 test_files:
+- spec/mr_clean/config_spec.rb
+- spec/mr_clean/filter_spec.rb
+- spec/mr_clean/profanity_spec.rb
 - spec/spec_helper.rb
-has_rdoc: