profane 0.0.2 → 0.0.3

data/README.md

@@ -17,6 +17,20 @@ Or install it yourself as:
 
     $ gem install profane
 
+## Usage
+
+Filter profanity from a bit of text:
+```
+Profane::Filter.filter('Voldemort!')
+=> '*********!')
+```
+
+Detect profanity in a bit of text:
+```
+Profane::Filter.profane?('If you come to a fork in the road, take it.')
+=> false
+```
+
 ## Configuration
 
 You can include words from your own dictionary in a hash or a yaml file, where
@@ -40,28 +54,15 @@ Profane.configure(dictionary: { obscenity: 'obs******' }, use_internal_dictionar
 Profane.configure(dictionary_file: 'config/dictionary.yml', use_internal_dictionary: false)
 ```
 
-If you set a key to '' in the dictionary profane will use the default strategy
+If you set a key to '' (blank string) in the dictionary profane will use the default strategy
 of overwriting the entire word (exempting punctuation) with '*'. You can pass an
 alternative character to use with the filter_character option.
 ```
 Profane.configure(filter_character: '&')
-```
-Note that if you want to actually replace words with blank string you can use ''
-as your default character.
-
-## Usage
-
-Filter profanity from a bit of text:
-```
 Profane::Filter.filter('Voldemort!')
-=> '*********!')
-```
-
-Detect profanity in a bit of text:
-```
-Profane::Filter.profane?('If you come to a fork in the road, take it.')
-=> 'false'
+=> '&&&&&&&&&!')
 ```
+Note that if you want to actually replace words with a blank string you can use '' as your default character.
 
 ## Thanks
 

data/lib/profane/filter.rb

@@ -16,6 +16,8 @@ module Profane
     end
 
     def profane?(phrase)
+      return false unless phrase
+
       phrase = phrase.downcase.split(/\s+/)
 
       dictionary.keys.each do |key|

data/lib/profane/version.rb

@@ -1,3 +1,3 @@
 module Profane
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/profane/filter_spec.rb

@@ -73,6 +73,11 @@ describe 'Profane::Filter' do
       filter.profane?('this is not profane').should be_false
     end
 
+    it "returns false given nil" do
+      filter = Profane::Filter.new
+      filter.profane?(nil).should be_false
+    end
+
     it "detects the presence of words from the default dictionary" do
       filter = Profane::Filter.new
       filter.profane?('fuck').should be_true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: profane
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler