sauber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ea0fbe8bfe03290d7721365566c45b9f3ed8fc4
+  data.tar.gz: 609a9e52c7369f193185659a64325fc9b55a2fea
+SHA512:
+  metadata.gz: 04d2e49917b4f7d3bb4193133ef6d7e47959aa7cfc8d05b63852548d971b6d45902e443a366c5507de3b4ab9177d7814fd4707e7a91b67d563a3a23c30028923
+  data.tar.gz: 4beb4c34a586fa0cbdf04fc970dde6d106c71abab559d38da214501e37180b65b551c3ab89b2455d9a4cec3bd4aed55cd6956a90c1aec8692381395e7d1730c1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install:
+  - gem install bundler
+install:
+  - bundle install
+addons:
+  code_climate:
+    repo_token: 6523a3eb32ccb84a0308d6308e038ce33c75e556fcb24dbf759dc8caad5d9d78
+notifications:
+  email:
+    recipients:
+      - icaro.seara@email.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sauber.gemspec
+gemspec
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Icaro Seara
+
+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,72 @@
+# Sauber
+
+A tiny profanity filter.
+
+[![Build Status](https://travis-ci.org/icaroseara/sauber.svg)](https://travis-ci.org/icaroseara/sauber) [![Code Climate](https://codeclimate.com/github/icaroseara/sauber/badges/gpa.svg)](https://codeclimate.com/github/icaroseara/sauber) [![Test Coverage](https://codeclimate.com/github/icaroseara/sauber/badges/coverage.svg)](https://codeclimate.com/github/icaroseara/sauber)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sauber'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sauber
+
+## Usage
+
+```ruby
+Sauber.configure do |config|
+  config.blacklist = ["bad", "crime", "war"]
+  config.whitelist = ["peace"]
+  config.replacement = :stars
+end
+```
+
+### Blacklist
+
+Words or phrases that you would like to remove.
+
+`config.whitelist` accepts the following values:
+
+- An array with words
+- A string representing a path to a yml file
+
+### Whitelist
+
+Phrases that contain a word from the blacklist that you don't wish to remove.
+
+`config.blacklist` accepts the following values:
+
+- An array with words
+- A string representing a path to a yml file
+
+### Replacement
+
+`config.replacement` accepts the following values:
+- :stars      : Replaces profane words with '*' up to the word's length
+
+### Basic Usage
+
+```ruby
+Sauber.clean("simple text")
+=> "simple text"
+
+Sauber.clean("text with shit")
+=> "text with ****"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sauber/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'bundler/gem_tasks'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+  # no rspec available
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sauber"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sauber.rb

@@ -0,0 +1,14 @@
+require "sauber/version"
+require 'sauber/base'
+
+module Sauber extend self
+  attr_accessor :whitelist, :blacklist, :replacement
+
+  def configure
+   yield self
+  end
+  
+  def clean text
+    Sauber::Base.clean text
+  end
+end

data/lib/sauber/base.rb

@@ -0,0 +1,53 @@
+module Sauber
+  class Base
+    class << self
+      def clean text 
+        return text if text.empty?
+        text.split(/(\s)/).collect{ |w| clean_word(w) }.join
+      end
+      
+      private
+      
+      def blacklist
+        @blacklist ||= get_content Sauber.blacklist
+      end
+      
+      def whitelist
+        @whitelist ||= get_content Sauber.whitelist
+      end
+      
+      def invalid? word
+        blacklist.include?(word.downcase) && !whitelist.include?(word.downcase)
+      end
+      
+      def replace word       
+        case Sauber.replacement
+        when :stars
+         '*' * word.length
+        else
+          word
+        end
+      end
+      
+      def clean_word word
+        return word unless word.strip.size > 2
+
+        if word.index(/[\W]/)
+          word = word.split(/(\W)/).collect{ |w| clean_word(w) }.join
+          subword = word.gsub(/\W/, '')
+          word = subword if invalid?(subword)
+        end
+
+        invalid?(word) ? replace(word) : word
+      end
+      
+      def get_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/sauber/version.rb

@@ -0,0 +1,3 @@
+module Sauber
+  VERSION = "0.1.0"
+end

data/sauber.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sauber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sauber"
+  spec.version       = Sauber::VERSION
+  spec.authors       = ["Icaro Seara"]
+  spec.email         = ["icaro.seara@gmail.com"]
+  spec.homepage      = 'https://github.com/icaroseara/sauber'
+  spec.summary       = 'A tiny profanity filter.'
+  spec.description   = 'A tiny profanity filter that use blacklist, whitelist and sanitization rules to clean up profanity in text.'
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "pry-nav"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: sauber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Icaro Seara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A tiny profanity filter that use blacklist, whitelist and sanitization
+  rules to clean up profanity in text.
+email:
+- icaro.seara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sauber.rb
+- lib/sauber/base.rb
+- lib/sauber/version.rb
+- sauber.gemspec
+homepage: https://github.com/icaroseara/sauber
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A tiny profanity filter.
+test_files: []