simple_blacklist 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 952c9eb375890475241b17c599065628d921cc4f
-  data.tar.gz: 771f98ef126b1f643196fc9427b19e95521facab
+  metadata.gz: bbdbf52e043433dc0d2ca2fadb094a43167cc9f6
+  data.tar.gz: 7ef374ce7af7a1056d4cbb6c5565092c14b67bb9
 SHA512:
-  metadata.gz: 777e986e5e970bab4fa4bae4c73528c279a6bdc30f056d2ed5ad1427383631d51fbe311d8507669a2b526dfa39739d01f16dc0d7313a52ffb424322e7aa07bc8
-  data.tar.gz: 50d524c7ca9717a825104c4d78684ff8cbaa6454560a88c74306f6323b592b9766eb04bccc4b9e5a79ad6bc30b4f473551d7bd6cc3b4acb8d09117d8a3ce8a07
+  metadata.gz: 7f21ebbf752aa71d750668dff2e4575e49243106a1ff901e6645b2141eb8576ec3c9adfa7f444758c421b3dec22a96ab49085eb790b3f481c8b5392ba783a96a
+  data.tar.gz: 73dced19be6e6791e53388469271703279acedb09b95c5526b9a05275fd053e7559d3934859d1a2db14bb3f5e5a64d5cd4abfe3971962e67937e98099a1caff6

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.idea/*

data/README.md

@@ -1,10 +1,8 @@
 # SimpleBlacklist
-___
 
 This project is designed to make easy the task of sanitizing string that contains words not allowed.
 
 ## Installation
-___
 
 Add this line to your application's Gemfile:
 
@@ -21,17 +19,15 @@ Or install it yourself as:
     $ gem install simple_blacklist
 
 ## Setup (Rails)
-___
 
     $ simple_blacklist --configure
 
 Will be created:
 
- * *config/initializers/simple_blacklist.rb*
- * *config/blacklist.yml*
+ * **config/initializers/simple_blacklist.rb** (file where are defined some parameters to the gem)
+ * **config/blacklist.yml** (list where you must add words that you want deny)
 
 ## Usage
-___
 
 In your code, do:
 
@@ -39,19 +35,18 @@ In your code, do:
 offensive_text = "Kiss my ass"
 SimpleBlacklist.sanitize(offensive_text)
 
-# "Kiss my xxxxx"
+# "Kiss my ****"
 ```
 
-If configured *letters_variations* is also possible to sanitize texts written with special characters
+If configured **letters_variations** is also possible to sanitize texts written with special characters
 ```ruby
 offensive_text = "Kiss my @$$"
 SimpleBlacklist.sanitize(offensive_text)
 
-# "Kiss my xxxxx"
+# "Kiss my ****"
 ```
 
 ## Development
-___
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -63,7 +58,6 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERN
 
 
 ## License
-___
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 

data/bin/simple_blacklist

@@ -1,50 +1,15 @@
 #!/usr/bin/env ruby
-require 'fileutils'
-require 'simple_blacklist/config'
+require 'simple_blacklist/setup'
 
-base = BLACKLIST_BASE
-config_dir = File.join(base, BLACKLIST_CONFIG['config_path'])
-initializers_dir = File.join(config_dir, BLACKLIST_CONFIG['initializers_path'])
-FileUtils.mkdir_p(config_dir) unless File.directory?(config_dir)
-FileUtils.mkdir_p(initializers_dir) unless File.directory?(initializers_dir)
-initializer_file = File.join(initializers_dir, 'simple_blacklist.rb')
-blacklist_file = File.join(config_dir, 'blacklist.yml')
+setup = SimpleBlacklist::Setup.new
 
 if ARGV.include? "--configure"
-  initializer_file_content = <<-FILE
-# Define simple_blacklist file
-SimpleBlacklist.set_blacklist_file(File.join(BLACKLIST_BASE, "config", "blacklist.yml"))
-
-# Defines masks that will replace the words contained in the simple_blacklist
-SimpleBlacklist.set_mask_to_denied_words("xxxxx")
-
-# list of letters and characters that can replace the letters
-SimpleBlacklist.set_letters_variations({
- 'a' => ['@', '4', 'ª'],
- 'e' => ['3', '&'],
- 'i' => ['|', '1'],
- 'o' => ['0', 'º'],
- 's' => ['$', '5'],
- 't' => ['7'],
- 'g' => ['6'],
- 'b' => ['6', '8']
-})
-  FILE
-
-  blacklist_file_content = <<-FILE
-ass
-fuck
-bitch
-  FILE
-
-  File.open(initializer_file, 'wb') {|f| f.write(initializer_file_content) } unless File.exist?(initializer_file)
-  File.open(blacklist_file, 'wb') {|f| f.write(blacklist_file_content) } unless File.exist?(blacklist_file)
-
+  setup.configure
   puts " ༼ つ ◕_◕ ༽つ OK... Gem has been set!!!    "
   exit
 end
 
-unless File.exist?(initializer_file)
+unless File.exist?(setup.initializer_file)
   puts " ༼ つ ◕_◕ ༽つ OOOPS... Gem has not yet been set. To set run 'simple_blacklist --configure'    "
   exit
 end

data/lib/simple_blacklist.rb

@@ -1,28 +1,42 @@
-require "simple_blacklist/config"
+require "simple_blacklist/setup"
 require "simple_blacklist/version"
 
 module SimpleBlacklist
-  @@file ||= File.join(BLACKLIST_BASE, BLACKLIST_CONFIG['config_path'], 'blacklist.yml')
+  @@blacklist_file ||= File.join(BLACKLIST_BASE, BLACKLIST_CONFIG['config_path'], 'blacklist.yml')
   @@letters_variations ||= {}
+  @@mask_denied_words ||= "****"
   @@blacklist ||= []
-  @@mask ||= "*****"
 
   module_function
-  def set_blacklist_file(file)
-    @@file = file
+  def blacklist_file=(file)
+    raise "Given blacklist_file is not a File" unless File.exist? file
+    @@blacklist_file = file
   end
 
-  def set_mask_to_denied_words(mask)
-    @@mask = mask
+  def blacklist_file
+    @@blacklist_file
   end
 
-  def set_letters_variations(list)
-    raise "Given object is not a hash" unless list.instance_of? Hash
+  def letters_variations=(list)
+    raise "Given letters_variations is not a Hash" unless list.instance_of? Hash
     @@letters_variations = list
   end
 
+  def letters_variations
+    @@letters_variations
+  end
+
+  def mask_denied_words=(mask)
+    raise "Given mask_denied_words is not a String" unless mask.instance_of? String
+    @@mask_denied_words = mask
+  end
+
+  def mask_denied_words
+    @@mask_denied_words
+  end
+
   def reload_blacklist
-    f = File.open(@@file, 'rb')
+    f = File.open(@@blacklist_file, 'rb')
     content = f.read
     @@blacklist = content.split(/\W+/)
     @@blacklist.map!(&:downcase)
@@ -30,22 +44,35 @@ module SimpleBlacklist
 
   def sanitize(text)
     reload_blacklist
-    words = text.split(/[\s,.]/)
+    words = text.split(/([[:space:]]|[.,;:]|[[:blank:]])/)
     words.each do |word|
-      replaced = replace_letters(word)
-      text.gsub!(/(#{word})+/i, @@mask) if @@blacklist.include? replaced.downcase
+      word_replaced = replace_letters(word)
+      if @@blacklist.include? word_replaced.downcase
+        if word_replaced.downcase == word.downcase
+          text.gsub!(/(\b([#{word.split('').join("][")}])\b)/i, @@mask_denied_words)
+        else
+          if text=~/(\B([#{word.split('').join("][")}])\B)/i
+            text.gsub!(/(\B([#{word.split('').join("][")}])\B)/i, @@mask_denied_words)
+          else
+            text.gsub!(/([#{word.split('').join("][")}])/i, @@mask_denied_words)
+          end
+        end
+      end
     end
     text
   end
 
   def replace_letters(word)
-    replaced = word.clone
+    word_replaced = word.clone
     chars = word.split('')
     chars.each do |char|
       @@letters_variations.each do |(key,list_chars)|
-        replaced.gsub!(/(#{char})+/i, "#{key}") if list_chars.include? char.downcase
+        if list_chars.include? char.downcase
+          word_replaced.gsub!(/[#{char}]/, "#{key}")
+        end
       end
     end
-    replaced
+    word_replaced
   end
+
 end

data/lib/simple_blacklist/setup.rb

@@ -0,0 +1,59 @@
+require 'fileutils'
+require 'simple_blacklist/config'
+
+module SimpleBlacklist
+  class Setup
+
+    attr_accessor :base, :config_dir, :initializers_dir, :initializer_file, :blacklist_file
+
+    def initialize
+      @base = BLACKLIST_BASE
+      @config_dir = File.join(base, BLACKLIST_CONFIG['config_path'])
+      @initializers_dir = File.join(@config_dir, BLACKLIST_CONFIG['initializers_path'])
+      FileUtils.mkdir_p(@config_dir) unless File.directory?(@config_dir)
+      FileUtils.mkdir_p(@initializers_dir) unless File.directory?(@initializers_dir)
+      @initializer_file = File.join(initializers_dir, 'simple_blacklist.rb')
+      @blacklist_file = File.join(config_dir, 'blacklist.yml')
+    end
+
+    def configure
+      create_initializer
+      create_blacklist
+    end
+
+    def create_initializer
+      initializer_file_content = <<-FILE
+# Define simple_blacklist file
+SimpleBlacklist.blacklist_file = File.join(BLACKLIST_BASE, "config", "blacklist.yml")
+
+# Defines masks that will replace the words contained in the simple_blacklist
+SimpleBlacklist.mask_denied_words = "****"
+
+# list of letters and characters that can replace the letters
+SimpleBlacklist.letters_variations = {
+ 'a' => ['@', '4'],
+ 'e' => ['3'],
+ 'i' => ['1', '|', '!'],
+ 'o' => ['0'],
+ 's' => ['$', '5'],
+ 't' => ['7', '+'],
+ 'g' => ['6'],
+ 'b' => ['8']
+}
+      FILE
+
+      File.open(@initializer_file, 'wb') {|f| f.write(initializer_file_content) } unless File.exist?(@initializer_file)
+    end
+
+    def create_blacklist
+      blacklist_file_content = <<-FILE
+ass
+fuck
+bitch
+      FILE
+
+      File.open(@blacklist_file, 'wb') {|f| f.write(blacklist_file_content) } unless File.exist?(@blacklist_file)
+    end
+
+  end
+end

data/lib/simple_blacklist/version.rb

@@ -1,3 +1,3 @@
 module SimpleBlacklist
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/simple_blacklist.gemspec

@@ -16,12 +16,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  # spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.summary       = %q{Simple Blacklist to sanitize strings}
   spec.description   = %q{This project is designed to make easy the task of sanitizing string that contains words not allowed. }
 
-  spec.add_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "bundler"
+
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/spec/simple_blacklist_spec.rb

@@ -1,11 +1,41 @@
 require 'spec_helper'
 
 describe SimpleBlacklist do
+  before(:all) do
+    @setup = SimpleBlacklist::Setup.new
+    @setup.configure
+    require @setup.initializer_file
+  end
+
+  after(:all) do
+    FileUtils.rm_rf @setup.config_dir
+  end
+
   it 'has a version number' do
     expect(SimpleBlacklist::VERSION).not_to be nil
   end
 
-  it 'does something useful' do
-    expect(true).to eq(true)
+  describe "#sanitize" do
+
+    subject(:text_simple) { 'kiss my ass' }
+    it 'a word contained in the blacklist is replaced' do
+      expect(SimpleBlacklist.sanitize(text_simple)).to eq('kiss my ****')
+    end
+
+    subject(:text_special_char) { 'kiss my @$$' }
+    it 'a word written with special characters is replaced' do
+      expect(SimpleBlacklist.sanitize(text_special_char)).to eq('kiss my ****')
+    end
+
+    subject(:text_with_word_like) { 'kiss my ass assassin' }
+    it 'a similar word (not contained in the blacklist) can not be replaced' do
+      expect(SimpleBlacklist.sanitize(text_with_word_like)).to eq('kiss my **** assassin')
+    end
+
+    subject(:text_special_char_with_word_like) { 'kiss my @$$ @$$assin' }
+    it 'a similar word with special characters (not contained in the blacklist) can not be replaced' do
+      expect(SimpleBlacklist.sanitize(text_special_char_with_word_like)).to eq('kiss my **** @$$assin')
+    end
+
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simple_blacklist
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Washington Silva
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +76,7 @@ files:
 - bin/simple_blacklist
 - lib/simple_blacklist.rb
 - lib/simple_blacklist/config.rb
+- lib/simple_blacklist/setup.rb
 - lib/simple_blacklist/version.rb
 - simple_blacklist.gemspec
 - spec/simple_blacklist_spec.rb
@@ -92,7 +93,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="