banned_words 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+doc
+Manifest
+.project
+spec/yamls/*
+*.gem
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color --format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in banned_words.gemspec
+gemspec

data/README.md

@@ -0,0 +1,24 @@
+# Banned Words
+Detects and masks banned words within a text
+
+## Installation
+
+Add this line in your Gemfile:
+
+```ruby
+gem 'banned_words'
+```
+
+## Usage
+
+```ruby
+BannedWords.create!('dog')
+phrase = 'The quick brown fox jumps over the lazy dog'
+BannedWords.mask(phrase)
+> 'The quick brown fox jumps over the lazy *Buzz*'
+
+# Another example:
+phrase = 'Red d-o-g'
+BannedWords.mask(phrase)
+> 'Red *Buzz*'
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/banned_words.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "banned_words"
+  s.version     = "0.1.0"
+  s.authors     = ["Razvan Secara", "Pop Sabina"]
+  s.email       = ["secara.razvan@yahoo.com"]
+  s.homepage    = ""
+  s.summary     = %q{Detects and masks banned words within a text}
+  s.description = %q{Detects and masks banned words within a text}
+
+  s.rubyforge_project = "banned_words"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rails", ">= 3.0"
+  s.add_runtime_dependency     "rails", ">= 3.0"
+end

data/lib/banned_words/core.rb

@@ -0,0 +1,87 @@
+require "banned_words/storage"
+
+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.
+  #
+  # ==== Parameters
+  #
+  # word<String>::
+  #    Contains no more than a word.
+  #    Returns nil if the word failed to be converted into a banned word.
+  #
+  def create!(word)
+
+    Storage::FileStore.ensure_storage_file
+    word = word.downcase.strip
+
+    if regexed_word = word_to_regex(word)
+      bw_file       = Storage::FileStore.load_storage
+      bw_file[word] = regexed_word
+      Storage::FileStore.write_to_storage(bw_file)
+    end
+
+    regexed_word
+  end
+
+  #
+  # Masks the banned words within supplied text.
+  # Returns the changed text. If no banned words are found then the initial text is returned.
+  #
+  # ==== Parameters
+  #
+  # text<String>::
+  #   The text which is checked for banned words.
+  # replace_with<String>::
+  #   The word which replaces the banned words. It defaults to *Buzz*.
+  #
+  def mask(text, replace_with = "*Buzz*")
+    # 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)
+      bw = banned_words.values.join("|")
+      text.gsub!(/#{bw}/i, replace_with)
+    end
+
+    text
+  end
+
+  #
+  # List the banned words. If the storage file isn't found an error is raised.
+  #
+  def list
+    Storage::FileStore.list_contents!
+  end
+
+  #
+  # Removes all banned words. If the storage file isn't found an error is raised.
+  #
+  def clear
+    Storage::FileStore.empty_storage!
+  end
+
+  private
+  
+  #
+  # Transforms the word into a banned word. The BW_REGEX gets attached between every char.
+  #
+  def word_to_regex(word)
+    # Don't bother processing if the word isn't present or has more than one word
+    return nil if word.blank? || word[" "]
+
+    regexed_word = ""
+    word.chars.each_with_index do |char, i|
+      regexed_word += char
+      # Don't attach the regex after the last char.
+      regexed_word += BW_REGEX if i < word.size - 1
+    end
+
+    regexed_word
+  end
+
+end

data/lib/banned_words/storage.rb

@@ -0,0 +1,89 @@
+module Storage
+  module FileStore
+    extend self
+
+    #
+    # Retruns the path to where the banned words file source is/should be located.
+    #
+    def file_path
+      "#{Rails.root}/lib/banned_words.yml"
+    end
+
+    #
+    # Returns true if the banned_words.yml file exisits, false otherwise
+    #
+    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.
+    #
+    # ==== Parameters
+    #
+    # value<Hash>::
+    #   Ex: {:banned_word_1 => "bw_regex_1", :banned_word_2 => "bw_regex_2"}
+    #
+    def write_to_storage(value = nil)
+      File.open(file_path, "w+") do |file|
+        YAML.dump(value, file)
+      end
+    end
+    
+    #
+    # Returns a hash containing the banned words.
+    # If no banned words are present the returned has is empty.
+    #
+    def list_contents
+      YAML.load_file(file_path) || {}
+    end
+    alias_method :load_storage, :list_contents
+    
+    #
+    # Returns a hash containing the banned words if the storage file exists.
+    # Otherwise an error is raised.
+    #
+    def list_contents!
+      if storage_exists?
+        list_contents
+      else
+        raise IOError, "No banned words file!"
+      end
+    end
+    
+    #
+    # Clear the storage.
+    #
+    def empty_storage
+      write_to_storage
+    end
+    alias_method :new_storage, :empty_storage
+    
+    #
+    # Clear storage file if it exists.
+    # Otherwise an error is raised.
+    #
+    def empty_storage!
+      if storage_exists?
+        empty_storage
+      else
+        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
+    #
+    def remove_storage_file
+      FileUtils.rm(file_path)
+    end
+  end
+end

data/lib/banned_words.rb

@@ -0,0 +1,6 @@
+require 'rails'
+require 'banned_words/core'
+
+module BannedWords
+  extend Core
+end

data/lib/rails/generators/banned_words_generator.rb

@@ -0,0 +1,7 @@
+class BannedWordsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+ 
+  def copy_banned_words_yaml_file  	
+    copy_file "banned_words.yml", "lib/banned_words.yml"
+  end
+end

data/lib/rails/generators/templates/banned_words.yml

@@ -0,0 +1 @@
+---

data/spec/banned_words_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe BannedWords do  
+end

data/spec/lib/core_spec.rb

@@ -0,0 +1,93 @@
+require "spec_helper"
+
+describe Core do
+  let(:banned_words) { ["quick", "jumps", "dog"] }
+
+  context ".create!" do
+    context "with success" do
+      it "adds a banned word to the storage file" do
+        BannedWords.list.size.should == 0
+        BannedWords.create!("punk")
+        list = BannedWords.list
+        list.size.should    == 1
+        list["punk"].should == "p[^a-zA-Z0-9]*u[^a-zA-Z0-9]*n[^a-zA-Z0-9]*k"
+      end
+    end
+
+    context "with errors" do
+      it "fails to add a banned word containing more than two words" do
+        BannedWords.list.size.should == 0
+        BannedWords.create!("jack black")
+        BannedWords.list.size.should == 0
+      end
+    end
+  end
+
+  context ".mask" do
+    before do
+      banned_words.each do |word|
+        BannedWords.create!(word)
+      end
+    end
+
+    context "success" do
+      it "detects & masks one banned word - dog" do
+        phrase     = "The dog is purple"
+        new_phrase = BannedWords.mask(phrase)
+        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
+    end
+
+    context "no changes" do
+      it "cannot find any banned words" do
+        phrase     = "Rock music records"
+        new_phrase = BannedWords.mask(phrase)
+        new_phrase.should == phrase
+      end
+    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)}
+      list = BannedWords.list
+      list.size.should == 2
+      list.keys.should == ["jack", "black"]
+    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!")
+    end
+  end
+
+  context ".clear" do
+    it "clears the banned words list" do
+      BannedWords.create!("wolf")
+      BannedWords.list.size.should == 1
+      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
+
+end

data/spec/lib/storage_spec.rb

@@ -0,0 +1,90 @@
+require "spec_helper"
+
+describe Storage::FileStore do
+
+  context ".storage_exists?" do
+    it "exists" do
+      Storage::FileStore.storage_exists?.should be_true
+    end
+    it "doesn't exist" do
+      Storage::FileStore.remove_storage_file
+      Storage::FileStore.storage_exists?.should be_false
+    end
+  end
+
+  context ".write_to_storage" do
+    it "writes something" do
+      add_and_check("something")
+    end
+  end
+
+  context ".list_contents" do
+    it "returns no elements" do
+      Storage::FileStore.list_contents.should == {}
+    end
+    it "returns one element" do
+      add_and_check("cat")
+    end
+  end
+
+  context ".list_contents!" do
+    it "returns one element" do
+      Storage::FileStore.write_to_storage("cat")
+      Storage::FileStore.list_contents!.should == "cat"
+    end
+
+    it "raises IOError" do
+      Storage::FileStore.remove_storage_file
+      expect { Storage::FileStore.list_contents! }.to raise_error(IOError, "No banned words file!")
+      Storage::FileStore.ensure_storage_file
+    end
+  end
+
+  context ".empty_storage" do
+    it "cleares all data" do
+      add_and_check("cat")
+      Storage::FileStore.empty_storage
+      Storage::FileStore.list_contents.should == {}
+    end
+  end
+
+  context ".empty_storage!" do
+    it "cleares all data" do
+      add_and_check("cat")
+      Storage::FileStore.empty_storage!
+      Storage::FileStore.list_contents.should == {}
+    end
+
+    it "raises IOError" do
+      Storage::FileStore.remove_storage_file
+      expect { Storage::FileStore.empty_storage! }.to raise_error(IOError, "No banned words file!")
+      Storage::FileStore.ensure_storage_file
+    end
+  end
+
+  context "aliases" do
+    context ".new_storage" do
+      it "behaves like .empty_storage with default parameter" do
+        ["new_storage", "empty_storage"].each do |method|
+          add_and_check("cat")
+          Storage::FileStore.send(method)
+          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
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "banned_words"
+
+RSpec.configure do |config|
+  config.before { stub_file_path }
+  config.after  { clear_banned_words_file }
+end
+
+def stub_file_path
+  Storage::FileStore.stub(:file_path).and_return("#{File.dirname(__FILE__)}/yamls/banned_words.yml")
+end
+
+def clear_banned_words_file
+  Storage::FileStore.ensure_storage_file
+  BannedWords.clear
+end

data/spec/yamls/banned_words.yml

@@ -0,0 +1,2 @@
+--- 
+...

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: banned_words
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Razvan Secara
+- Pop Sabina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20016960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20016960
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &20015860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *20015860
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &20015360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20015360
+description: Detects and masks banned words within a text
+email:
+- secara.razvan@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- banned_words.gemspec
+- lib/banned_words.rb
+- lib/banned_words/core.rb
+- lib/banned_words/storage.rb
+- lib/rails/generators/banned_words_generator.rb
+- lib/rails/generators/templates/banned_words.yml
+- spec/banned_words_spec.rb
+- spec/lib/core_spec.rb
+- spec/lib/storage_spec.rb
+- spec/spec_helper.rb
+- spec/yamls/banned_words.yml
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: banned_words
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Detects and masks banned words within a text
+test_files: []