banned_words 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Razvan Secara
+
+MIT License
+
+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

@@ -1,6 +1,8 @@
 # Banned Words
 Detects and masks banned words within a text
 
+[![Build Status](https://secure.travis-ci.org/razvan-sv/banned_words.png?branch=master)](http://travis-ci.org/razvan-sv/banned_words)
+
 ## Installation
 
 Add this line in your Gemfile:
@@ -8,17 +10,60 @@ Add this line in your Gemfile:
 ```ruby
 gem 'banned_words'
 ```
+Then you need to run:
+
+```ruby
+rails g banned_words
+```
+to generate the banned_words.yml file.
 
 ## Usage
 
+### Masking
 ```ruby
+# Single banned word
 BannedWords.create!('dog')
+phrase = 'Red d-o-g'
+BannedWords.mask(phrase)
+> 'Red *Buzz*'
+
+# With an array of banned words
+BannedWords.create!(['fox', 'over'])
 phrase = 'The quick brown fox jumps over the lazy dog'
 BannedWords.mask(phrase)
-> 'The quick brown fox jumps over the lazy *Buzz*'
+> 'The quick brown *Buzz* jumps *Buzz* the lazy *Buzz*'
+
+# Override the masking word
+BannedWords.mask(phrase, "*Bad Word*")
+> 'The quick brown *Bad Word* jumps *Bad Word* the lazy *Bad Word*'
+```
+
+### Detecting
+```ruby
+BannedWords.create!(['quick', 'jumps'])
+phrase = 'The q-u#-_^i!c~k brown fox j=u m p?s over the lazy dog'
+BannedWords.detect(phrase)
+> ['q-u#-_^i!c~k', 'j=u m p?s']
+```
+
+### Listing
+```ruby
+BannedWords.list
+> ['dog', 'fox', 'over']
+```
+
+### Removing
+```ruby
+BannedWords.remove('dog')
+BannedWords.list
+> ['fox', 'over']
 
 # Another example:
-phrase = 'Red d-o-g'
-BannedWords.mask(phrase)
-> 'Red *Buzz*'
-```
+BannedWords.remove(['fox', 'over'])
+BannedWords.list
+> []
+```
+
+## Copyright
+
+See LICENSE for details.

data/banned_words.gemspec

@@ -3,10 +3,10 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "banned_words"
-  s.version     = "0.1.0"
+  s.version     = "0.1.1"
   s.authors     = ["Razvan Secara", "Pop Sabina"]
   s.email       = ["secara.razvan@yahoo.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/razvan-sv/banned_words"
   s.summary     = %q{Detects and masks banned words within a text}
   s.description = %q{Detects and masks banned words within a text}
 

data/lib/banned_words/core.rb

@@ -5,27 +5,30 @@ module Core
   BW_REGEX = "[^a-zA-Z0-9]*"
 
   #
-  # Create a banned word. The supplied word is transformed into a banned word
-  # and stored into the storage file. The banned word is returned.
+  # Create banned words. The supplied words are transformed into a banned words
+  # and stored into the storage file. An array of banned words is returned.
   #
   # ==== Parameters
   #
-  # word<String>::
-  #    Contains no more than a word.
-  #    Returns nil if the word failed to be converted into a banned word.
+  # words<String> or <Array>::
+  #    Contains a word or an array of words. The words should not contain spaces.
   #
-  def create!(word)
+  def create!(words)
 
     Storage::FileStore.ensure_storage_file
-    word = word.downcase.strip
+    words = words_to_array(words)
 
-    if regexed_word = word_to_regex(word)
+    if words.present?
       bw_file       = Storage::FileStore.load_storage
-      bw_file[word] = regexed_word
+      regexed_words = words.map do |word|
+        if regexed_word = word_to_regex(word)
+          bw_file[word] = regexed_word
+        end
+      end
       Storage::FileStore.write_to_storage(bw_file)
     end
 
-    regexed_word
+    regexed_words || []
   end
 
   #
@@ -43,7 +46,7 @@ module Core
     # Don't bother verifying if the text isn't present
     return nil unless text.present?
 
-    if banned_words = YAML.load_file(Storage::FileStore.file_path)
+    if banned_words = Storage::FileStore.load_storage
       bw = banned_words.values.join("|")
       text.gsub!(/#{bw}/i, replace_with)
     end
@@ -59,14 +62,54 @@ module Core
   end
 
   #
-  # Removes all banned words. If the storage file isn't found an error is raised.
+  # Detects the banned words in the supplied text.
+  # It returnes an array containing the found banned words.
+  # An empty array is returned if no banned words are found.
+  #
+  # ==== Parameters
+  #
+  # text<String>::
+  #   The text which is checked for banned words.
+  #
+  def detect(text)
+    # Don't bother verifying if the text isn't present
+    return [] unless text.present?
+
+    if banned_words = Storage::FileStore.load_storage
+      bw = banned_words.values.join("|")
+      return text.scan(/#{bw}/i)
+    end
+
+    []
+  end
+
+  #
+  # Removes all banned words from the storage fild.
+  # If the storage file isn't found an error is raised.
   #
   def clear
     Storage::FileStore.empty_storage!
   end
 
+  #
+  # Removes the supplied banned words from the list.
+  #
+  # ==== Parameters
+  #
+  # words<String> or <Array>::
+  #    Contains a word or an array of words.
+  #
+  def remove(words)
+    words = words_to_array(words)
+
+    if (bw_list = Storage::FileStore.load_storage).present?
+      new_bw = bw_list.reject { |name, regexed_name| words.include?(name) }
+      Storage::FileStore.write_to_storage(new_bw) if new_bw != bw_list
+    end
+  end
+
   private
-  
+
   #
   # Transforms the word into a banned word. The BW_REGEX gets attached between every char.
   #
@@ -75,6 +118,7 @@ module Core
     return nil if word.blank? || word[" "]
 
     regexed_word = ""
+    word = word.downcase.strip
     word.chars.each_with_index do |char, i|
       regexed_word += char
       # Don't attach the regex after the last char.
@@ -84,4 +128,11 @@ module Core
     regexed_word
   end
 
+  #
+  # TODO
+  #
+  def words_to_array(words)
+    words.is_a?(Array) ? words : [words]
+  end
+
 end

data/lib/banned_words/storage.rb

@@ -15,7 +15,7 @@ module Storage
     def storage_exists?
       File.exists?(file_path)
     end
-    
+
     #
     # Write new data to storage. The supplied hash value will overwrite the
     # exising data from the storage.
@@ -30,18 +30,26 @@ module Storage
         YAML.dump(value, file)
       end
     end
-    
+
     #
-    # Returns a hash containing the banned words.
-    # If no banned words are present the returned has is empty.
+    # Returns a hash containing the banned words along with their regexes.
+    # If no banned words are present the returned hash is empty.
     #
-    def list_contents
+    def load_storage
       YAML.load_file(file_path) || {}
     end
-    alias_method :load_storage, :list_contents
-    
+
     #
-    # Returns a hash containing the banned words if the storage file exists.
+    # Returns an array containing the banned words.
+    # If no banned words are present the returned array is empty.
+    #
+    def list_contents
+      list = load_storage
+      list.is_a?(Hash) ? list.keys.sort : [list]
+    end
+
+    #
+    # Returns an array containing the banned words if the storage file exists.
     # Otherwise an error is raised.
     #
     def list_contents!
@@ -51,7 +59,7 @@ module Storage
         raise IOError, "No banned words file!"
       end
     end
-    
+
     #
     # Clear the storage.
     #
@@ -59,7 +67,7 @@ module Storage
       write_to_storage
     end
     alias_method :new_storage, :empty_storage
-    
+
     #
     # Clear storage file if it exists.
     # Otherwise an error is raised.
@@ -71,14 +79,14 @@ module Storage
         raise IOError, "No banned words file!"
       end
     end
-    
+
     #
     # Creates the storage file if it's not present
     #
     def ensure_storage_file
       new_storage if !storage_exists?
     end
-    
+
     #
     # Mostly used in specs
     #

data/spec/lib/core_spec.rb

@@ -2,15 +2,27 @@ require "spec_helper"
 
 describe Core do
   let(:banned_words) { ["quick", "jumps", "dog"] }
+  let(:cart_regex)   { "c[^a-zA-Z0-9]*a[^a-zA-Z0-9]*r[^a-zA-Z0-9]*t" }
+  let(:phrase)       { "The q-u#-_^i!c~k brown fox j=u m p?s over the lazy dog" }
 
   context ".create!" do
     context "with success" do
-      it "adds a banned word to the storage file" do
+      it "single banned word" do
         BannedWords.list.size.should == 0
-        BannedWords.create!("punk")
-        list = BannedWords.list
+        BannedWords.create!("cart").should == [cart_regex]
+        list = Storage::FileStore.load_storage
         list.size.should    == 1
-        list["punk"].should == "p[^a-zA-Z0-9]*u[^a-zA-Z0-9]*n[^a-zA-Z0-9]*k"
+        list["cart"].should == cart_regex
+      end
+      it "array of banned words" do
+        BannedWords.list.size.should == 0
+        result = BannedWords.create!(banned_words)
+        result.should == [
+          "q[^a-zA-Z0-9]*u[^a-zA-Z0-9]*i[^a-zA-Z0-9]*c[^a-zA-Z0-9]*k",
+          "j[^a-zA-Z0-9]*u[^a-zA-Z0-9]*m[^a-zA-Z0-9]*p[^a-zA-Z0-9]*s",
+          "d[^a-zA-Z0-9]*o[^a-zA-Z0-9]*g"
+        ]
+        BannedWords.list.size.should == 3
       end
     end
 
@@ -25,9 +37,7 @@ describe Core do
 
   context ".mask" do
     before do
-      banned_words.each do |word|
-        BannedWords.create!(word)
-      end
+      BannedWords.create!(banned_words)
     end
 
     context "success" do
@@ -37,15 +47,17 @@ describe Core do
         new_phrase.should == "The *Buzz* is purple"
         new_phrase.should_not include "dog"
       end
-
       it "detects & masks more banned words - dog, jumps, quick" do
-        phrase     = "The quick brown fox jumps over the lazy dog"
         new_phrase = BannedWords.mask(phrase)
         new_phrase.should == "The *Buzz* brown fox *Buzz* over the lazy *Buzz*"
         banned_words.each do |bw|
           new_phrase.should_not include bw
         end
       end
+      it "mask with *Bad Word*" do
+        new_phrase = BannedWords.mask(phrase, "*Bad Word*")
+        new_phrase.should == "The *Bad Word* brown fox *Bad Word* over the lazy *Bad Word*"
+      end
     end
 
     context "no changes" do
@@ -55,21 +67,32 @@ describe Core do
         new_phrase.should == phrase
       end
     end
+  end
 
+  context ".detect" do
+    it "returns banned words within a text" do
+      BannedWords.create!(banned_words)
+      BannedWords.detect(phrase).should == ["q-u#-_^i!c~k", "j=u m p?s", "dog"]
+    end
+    it "doesn't find any banned words" do
+      BannedWords.create!(banned_words)
+      BannedWords.detect("How do you do").should == []
+    end
+    it "no text is supplied" do
+      BannedWords.detect("").should == []
+    end
   end
 
   context ".list" do
     it "no banned words in list" do
       BannedWords.list.size.should == 0
     end
-
     it "displays 2 banned words" do
-      ["jack", "black"].map {|word| BannedWords.create!(word)}
+      BannedWords.create!(["jack", "black"])
       list = BannedWords.list
       list.size.should == 2
-      list.keys.should == ["jack", "black"]
+      list.should == ["black", "jack"]
     end
-
     it "raises an error if the banned words file isn't found" do
       Storage::FileStore.remove_storage_file
       expect { BannedWords.list }.to raise_error(IOError, "No banned words file!")
@@ -83,11 +106,27 @@ describe Core do
       BannedWords.clear
       BannedWords.list.size.should == 0
     end
-
     it "raises NoBannedWordsFile" do
       Storage::FileStore.remove_storage_file
       expect { BannedWords.clear }.to raise_error(IOError, "No banned words file!")
     end
   end
 
+  context ".remove" do
+    before do
+      BannedWords.create!(banned_words)
+    end
+    it "one banned word" do
+      BannedWords.remove("dog")
+      BannedWords.list.should == ["jumps", "quick"]
+    end
+    it "many banned words" do
+      BannedWords.remove(["dog", "quick"])
+      BannedWords.list.should == ["jumps"]
+    end
+    it "banned word not found" do
+      BannedWords.remove(["ringo"])
+      BannedWords.list.should == ["dog", "jumps", "quick"]
+    end
+  end
 end

data/spec/lib/storage_spec.rb

@@ -20,7 +20,7 @@ describe Storage::FileStore do
 
   context ".list_contents" do
     it "returns no elements" do
-      Storage::FileStore.list_contents.should == {}
+      Storage::FileStore.list_contents.should == []
     end
     it "returns one element" do
       add_and_check("cat")
@@ -30,7 +30,7 @@ describe Storage::FileStore do
   context ".list_contents!" do
     it "returns one element" do
       Storage::FileStore.write_to_storage("cat")
-      Storage::FileStore.list_contents!.should == "cat"
+      Storage::FileStore.list_contents!.should == ["cat"]
     end
 
     it "raises IOError" do
@@ -44,7 +44,7 @@ describe Storage::FileStore do
     it "cleares all data" do
       add_and_check("cat")
       Storage::FileStore.empty_storage
-      Storage::FileStore.list_contents.should == {}
+      Storage::FileStore.list_contents.should == []
     end
   end
 
@@ -52,7 +52,7 @@ describe Storage::FileStore do
     it "cleares all data" do
       add_and_check("cat")
       Storage::FileStore.empty_storage!
-      Storage::FileStore.list_contents.should == {}
+      Storage::FileStore.list_contents.should == []
     end
 
     it "raises IOError" do
@@ -68,23 +68,16 @@ describe Storage::FileStore do
         ["new_storage", "empty_storage"].each do |method|
           add_and_check("cat")
           Storage::FileStore.send(method)
-          Storage::FileStore.list_contents.should == {}
+          Storage::FileStore.list_contents.should == []
         end
       end
     end
-
-    context ".load_storage" do
-      it "behaves like .list_contents" do
-        Storage::FileStore.write_to_storage("mouse")
-        Storage::FileStore.load_storage.should == Storage::FileStore.list_contents
-      end
-    end
   end
 
   private
 
   def add_and_check(word)
     Storage::FileStore.write_to_storage(word)
-    Storage::FileStore.list_contents.should == word
+    Storage::FileStore.list_contents.should == [word]
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banned_words
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-21 00:00:00.000000000Z
+date: 2012-03-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20016960 !ruby/object:Gem::Requirement
+  requirement: &16334280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20016960
+  version_requirements: *16334280
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &20015860 !ruby/object:Gem::Requirement
+  requirement: &16333760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *20015860
+  version_requirements: *16333760
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &20015360 !ruby/object:Gem::Requirement
+  requirement: &16333260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *20015360
+  version_requirements: *16333260
 description: Detects and masks banned words within a text
 email:
 - secara.razvan@yahoo.com
@@ -54,7 +54,9 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - banned_words.gemspec
@@ -68,7 +70,7 @@ files:
 - spec/lib/storage_spec.rb
 - spec/spec_helper.rb
 - spec/yamls/banned_words.yml
-homepage: ''
+homepage: https://github.com/razvan-sv/banned_words
 licenses: []
 post_install_message: 
 rdoc_options: []