filters 1.0.0

data/History.rdoc

@@ -0,0 +1,4 @@
+
+=== 1.0.0 / 2009-10-08
+
+* Initial release

data/Manifest

@@ -0,0 +1,24 @@
+History.rdoc
+Manifest
+README.rdoc
+Rakefile
+filters.gemspec
+lib/filters.rb
+lib/filters/all.rb
+lib/filters/email.rb
+lib/filters/filter.rb
+lib/filters/markup.rb
+lib/filters/phrase.rb
+lib/filters/profanity.rb
+lib/filters/uri.rb
+lib/filters/version.rb
+spec/filter_email_spec.rb
+spec/filter_markup_spec.rb
+spec/filter_phrase_spec.rb
+spec/filter_profanity_spec.rb
+spec/filter_uri_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake

data/README.rdoc

@@ -0,0 +1,109 @@
+
+= Filters
+
+Ruby text filters consisting of the following core filters:
+
+* phrase
+* profanity (uses phrase)
+* email (converts emails to mailto: anchor tags)
+* uri (converts uris to anchor tags)
+* markup (mini-markup language)
+
+== Filter::Phrase
+
+  Filter::Phrase('bad word!', :phrases => ['bad'])
+  # => 'word!'
+  
+  Filter::Phrase('bad word!', :phrases => ['bad'], :mask => '*')
+  # => '*** word!'
+  
+  Filter::Phrase('bad word!', :phrases => ['bad'], :mask => '[removed]')
+  # => '[removed] word!'
+  
+  Filter::Phrase('foobar', :phrases => ['foo(bar)?'])
+  # => ''
+  
+  Filter::Phrase('foobar', :phrases => [/foo(bar)?/])
+  # => ''
+  
+  Filter::Phrase('some foo bar', :phrases => [['foo', '*'], ['bar', '[removed]']])
+  # => 'some *** [removed]'
+  
+== Filter::Profanity < Filter::Phrase
+
+  Filter::Profanity('fuck this shit is so awesome i cant fucking believe it')
+  # => 'this is so awesome i cant believe it'
+  
+  Filter::Profanity('fuck this shit is so awesome i cant fucking believe it', :mask => '*')
+  # => '**** this **** is so awesome i cant ******* believe it'
+  
+== Filter::URI
+
+  Filter::URI('hey checkout http://vision-media.ca sometime')
+  # => 'hey checkout <a href="http://vision-media.ca">sometime</a>'
+  
+== Filter::Email
+
+  Filter::Email('hey email me@foo.com sometime')
+  # => 'hey email <a href="mailto:me@foo.com">sometime</a> sometime'
+  
+== Filter::Markup
+
+  Filter::Markup <<-EOF
+    = Welcome
+    
+    == Article
+    
+    This article is meant to show how a simple *markup* language
+    can be generated using the filter gem.
+    
+    === Source
+    
+    @@@ javascript
+      foo = function(){
+        bar()
+      }
+    @@@
+  EOF
+  
+Would output:
+
+  <h1>Welcome</h1>
+  
+  <h2>Article</h2>
+  
+  <p> This article is meant to show how a simple <strong>markup</strong> language
+  can be generated using the filter gem. </p>
+  
+  <h3>Source</h3>
+  
+  <code class="javascript">
+    foo = function(){
+      bar()
+    }
+  </code>
+  
+== License:
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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/Rakefile

@@ -0,0 +1,16 @@
+
+$:.unshift 'lib'
+require 'filters'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "filters", Filter::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Text filters including phrases, profanity, mini-markdown, uri, email, etc"
+  p.url = "http://github.com/visionmedia/filters"
+  p.runtime_dependencies = []
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/filters.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{filters}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-10-10}
+  s.description = %q{Text filters including phrases, profanity, mini-markdown, uri, email, etc}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["README.rdoc", "lib/filters.rb", "lib/filters/all.rb", "lib/filters/email.rb", "lib/filters/filter.rb", "lib/filters/markup.rb", "lib/filters/phrase.rb", "lib/filters/profanity.rb", "lib/filters/uri.rb", "lib/filters/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "filters.gemspec", "lib/filters.rb", "lib/filters/all.rb", "lib/filters/email.rb", "lib/filters/filter.rb", "lib/filters/markup.rb", "lib/filters/phrase.rb", "lib/filters/profanity.rb", "lib/filters/uri.rb", "lib/filters/version.rb", "spec/filter_email_spec.rb", "spec/filter_markup_spec.rb", "spec/filter_phrase_spec.rb", "spec/filter_profanity_spec.rb", "spec/filter_uri_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.homepage = %q{http://github.com/visionmedia/filters}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Filters", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{filters}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Text filters including phrases, profanity, mini-markdown, uri, email, etc}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/filters.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+require 'filters/version'
+require 'filters/filter'

data/lib/filters/all.rb

@@ -0,0 +1,6 @@
+
+require 'filters/phrase'
+require 'filters/profanity'
+require 'filters/markup'
+require 'filters/email'
+require 'filters/uri'

data/lib/filters/email.rb

@@ -0,0 +1,20 @@
+
+class Filter
+  class Email < self
+    
+    #--
+    # Constants
+    #++
+    
+    EMAIL = /[\w\-\.]+@(?:(?:[\w\-]+\.)+)[a-z]{2,4}\b/
+    
+    ##
+    # Convert emails to anchor tags.
+    
+    def filter!
+      string.gsub! EMAIL, '<a href="mailto:\0">\0</a>'
+      string
+    end
+    
+  end
+end

data/lib/filters/filter.rb

@@ -0,0 +1,26 @@
+
+class Filter
+  
+  ##
+  # Input string.
+  
+  attr_reader :string
+  
+  ##
+  # Initialize with _string_ and _options_.
+  
+  def initialize string, options = {}
+    @string, @options = string, options
+  end
+  
+  ##
+  # Auto generate Filter::Subclass() methods which
+  # act as a shortcut to Filter::Subclass.new(...).filter!
+  
+  def self.inherited subclass
+    (class << self; self end).send :define_method, subclass.name.split('::').last do |*args|
+      subclass.new(*args).filter!
+    end
+  end
+  
+end

data/lib/filters/markup.rb

@@ -0,0 +1,26 @@
+
+class Filter
+  class Markup < self
+    
+    ##
+    # Filter mini-markup language.
+    
+    def filter!
+      string.gsub! /\*([^*]+)\*/, '<strong>\1</strong>'
+      string.gsub! /\/([^*]+)\//, '<em>\1</em>'
+      string.gsub! /_([^*]+)_/, '<sub>\1</sub>'
+      string.gsub! /-([^*]+)-/, '<sup>\1</sup>'
+      string.gsub! /['"](.*?)['"]:([\w\-\.]+@\S+)/, '<a href="mailto:\2">\1</a>'
+      string.gsub! /['"](.*?)['"]:(\S+)/, '<a href="\2">\1</a>'
+      string.gsub! /@@@\s*\n(.*?)@@@/m, "<pre>\n\\1</pre>"
+      string.gsub! /@@@\s*(\w+)(.*?)@@@/m, '<code class="\1">\2</code>'
+      string.gsub! /h(\d)\s*([^\n]+)/, '<h\1>\2</h\1>'
+      string.gsub! /^\s*(={1,5})\s*([^\n]+)/ do |heading|
+        bar, contents = heading.split
+        "<h#{bar.length}>#{contents}</h#{bar.length}>"
+      end
+      string
+    end
+    
+  end
+end

data/lib/filters/phrase.rb

@@ -0,0 +1,51 @@
+
+class Filter
+  class Phrase < self
+    
+    ##
+    # Array of phrases.
+    
+    attr_reader :phrases
+    
+    ##
+    # Mask string.
+    
+    attr_reader :mask
+    
+    ##
+    # Initialize with _string_ and _options_.
+    
+    def initialize string, options = {}
+      super
+      @phrases = options.fetch :phrases, []
+      @mask = options.fetch :mask, nil
+    end
+    
+    ##
+    # Filter phrases.
+    
+    def filter!
+      phrases.each do |phrase|
+        if phrase.is_a? Array
+          filter_with phrase.shift, phrase.shift
+        else
+          filter_with phrase, mask
+        end
+      end
+      string.strip
+    end
+    
+    private
+    
+    def filter_with phrase, mask = nil
+      if mask && mask.length == 1
+        string.gsub! /\b#{phrase}(\s+|$)/, mask * phrase.to_s.length + '\1'
+      elsif mask
+        string.gsub! /\b#{phrase}(\s+|$)/, mask + '\1'
+      else
+        string.gsub! /\b#{phrase}(?:\s+|$)/, ''
+      end
+    end
+    
+  end
+end

data/lib/filters/profanity.rb

@@ -0,0 +1,306 @@
+
+require 'filters/phrase'
+
+class Filter
+  class Profanity < Phrase
+    
+    #--
+    # Constants
+    #++
+    
+    PHRASES = [
+        :'ass',
+        :'ass lick',
+        :'asses',
+        :'asshole',
+        :'assholes',
+        :'asskisser',
+        :'asswipe',
+        :'balls',
+        :'bastard',
+        :'beastial',
+        :'beastiality',
+        :'beastility',
+        :'beaver',
+        :'belly whacker',
+        :'bestial',
+        :'bestiality',
+        :'bitch',
+        :'bitcher',
+        :'bitchers',
+        :'bitches',
+        :'bitchin',
+        :'bitching',
+        :'blow job',
+        :'blowjob',
+        :'blowjobs',
+        :'bonehead',
+        :'boner',
+        :'brown eye',
+        :'browneye',
+        :'browntown',
+        :'bucket cunt',
+        :'bull shit',
+        :'bullshit',
+        :'bum',
+        :'bung hole',
+        :'butch',
+        :'butt',
+        :'butt breath',
+        :'butt fucker',
+        :'butt hair',
+        :'buttface',
+        :'buttfuck',
+        :'buttfucker',
+        :'butthead',
+        :'butthole',
+        :'buttpicker',
+        :'chink',
+        :'christ',
+        :'circle jerk',
+        :'clam',
+        :'clit',
+        :'cobia',
+        :'cock',
+        :'cocks',
+        :'cocksuck',
+        :'cocksucked',
+        :'cocksucker',
+        :'cocksucking',
+        :'cocksucks',
+        :'cooter',
+        :'crap',
+        :'cum',
+        :'cummer',
+        :'cumming',
+        :'cums',
+        :'cumshot',
+        :'cunilingus',
+        :'cunillingus',
+        :'cunnilingus',
+        :'cunt',
+        :'cuntlick',
+        :'cuntlicker',
+        :'cuntlicking',
+        :'cunts',
+        :'cyberfuc',
+        :'cyberfuck',
+        :'cyberfucked',
+        :'cyberfucker',
+        :'cyberfuckers',
+        :'cyberfucking',
+        :'damn',
+        :'dick',
+        :'dike',
+        :'dildo',
+        :'dildos',
+        :'dink',
+        :'dinks',
+        :'dipshit',
+        :'dong',
+        :'douche bag',
+        :'dumbass',
+        :'dyke',
+        :'ejaculate',
+        :'ejaculated',
+        :'ejaculates',
+        :'ejaculating',
+        :'ejaculatings',
+        :'ejaculation',
+        :'fag',
+        :'fagget',
+        :'fagging',
+        :'faggit',
+        :'faggot',
+        :'faggs',
+        :'fagot',
+        :'fagots',
+        :'fags',
+        :'fart',
+        :'farted',
+        :'farting',
+        :'fartings',
+        :'farts',
+        :'farty',
+        :'fatass',
+        :'fatso',
+        :'felatio',
+        :'fellatio',
+        :'fingerfuck',
+        :'fingerfucked',
+        :'fingerfucker',
+        :'fingerfuckers',
+        :'fingerfucking',
+        :'fingerfucks',
+        :'fistfuck',
+        :'fistfucked',
+        :'fistfucker',
+        :'fistfuckers',
+        :'fistfucking',
+        :'fistfuckings',
+        :'fistfucks',
+        :'fuck',
+        :'fucked',
+        :'fucker',
+        :'fuckers',
+        :'fuckin',
+        :'fucking',
+        :'fuckings',
+        :'fuckme',
+        :'fucks',
+        :'fuk',
+        :'fuks',
+        :'furburger',
+        :'gangbang',
+        :'gangbanged',
+        :'gangbangs',
+        :'gaysex',
+        :'gazongers',
+        :'goddamn',
+        :'gonads',
+        :'gook',
+        :'guinne',
+        :'hard on',
+        :'hardcoresex',
+        :'hell',
+        :'homo',
+        :'hooker',
+        :'horniest',
+        :'horny',
+        :'hotsex',
+        :'hussy',
+        :'jack off',
+        :'jackass',
+        :'jacking off',
+        :'jackoff',
+        :'jack-off',
+        :'jap',
+        :'jerk',
+        :'jerk-off',
+        :'jesus',
+        :'jesus christ',
+        :'jew',
+        :'jism',
+        :'jiz',
+        :'jizm',
+        :'jizz',
+        :'kike',
+        :'knob',
+        :'kock',
+        :'kondum',
+        :'kondums',
+        :'kraut',
+        :'kum',
+        :'kummer',
+        :'kumming',
+        :'kums',
+        :'kunilingus',
+        :'lesbian',
+        :'lesbo',
+        :'loser',
+        :'lust',
+        :'lusting',
+        :'merde',
+        :'mick',
+        :'mothafuck',
+        :'mothafucka',
+        :'mothafuckas',
+        :'mothafuckaz',
+        :'mothafucked',
+        :'mothafucker',
+        :'mothafuckers',
+        :'mothafuckin',
+        :'mothafucking',
+        :'mothafuckings',
+        :'mothafucks',
+        :'motherfuck',
+        :'motherfucked',
+        :'motherfucker',
+        :'motherfuckers',
+        :'motherfuckin',
+        :'motherfucking',
+        :'motherfuckings',
+        :'motherfucks',
+        :'mound',
+        :'muff',
+        :'nerd',
+        :'nigger',
+        :'niggers',
+        :'orgasim',
+        :'orgasims',
+        :'orgasm',
+        :'orgasms',
+        :'pecker',
+        :'penis',
+        :'phonesex',
+        :'phuk',
+        :'phuked',
+        :'phuking',
+        :'phukked',
+        :'phukking',
+        :'phuks',
+        :'phuq',
+        :'pimp',
+        :'piss',
+        :'pissed',
+        :'pisser',
+        :'pissers',
+        :'pisses',
+        :'pissin',
+        :'pissing',
+        :'pissoff',
+        :'porn',
+        :'porno',
+        :'pornography',
+        :'pornos',
+        :'prick',
+        :'pricks',
+        :'prostitute',
+        :'punk',
+        :'pussies',
+        :'pussy',
+        :'pussys',
+        :'queer',
+        :'retard',
+        :'schlong',
+        :'screw',
+        :'sheister',
+        :'shit',
+        :'shited',
+        :'shitfull',
+        :'shiting',
+        :'shitings',
+        :'shits',
+        :'shitted',
+        :'shitter',
+        :'shitters',
+        :'shitting',
+        :'shittings',
+        :'shitty',
+        :'slag',
+        :'sleaze',
+        :'slut',
+        :'sluts',
+        :'smut',
+        :'snatch',
+        :'spunk',
+        :'twat',
+        :'wetback',
+        :'whore',
+        :'wop'
+      ]
+    
+    ##
+    # Initialize with _string_ and _options_.
+    
+    def initialize string, options = {}
+      super
+      @phrases |= PHRASES
+    end
+    
+  end
+  
+  def self.Profanity *args
+    Profanity.new(*args).filter!
+  end
+end

data/lib/filters/uri.rb

@@ -0,0 +1,33 @@
+
+class Filter
+  class URI < self
+    
+    ##
+    # Weither or not to open in a new window.
+    
+    attr_reader :new_window
+    
+    ##
+    # Initialize with _string_ and _options_.
+    
+    def initialize string, options = {}
+      super
+      @new_window = options.fetch :new_window, false
+    end
+    
+    ##
+    # Convert URIs to anchor tags.
+    
+    def filter!
+      string.gsub! /\w+:\/\/(.*?)(\s+|$)/ do |uri|
+        if new_window
+          %(<a href="#{uri.strip}" target="_blank">#{uri}</a>)
+        else
+          %(<a href="#{uri.strip}">#{uri}</a>)
+        end
+      end
+      string
+    end
+    
+  end
+end

data/lib/filters/version.rb

@@ -0,0 +1,4 @@
+
+class Filter
+  VERSION = '1.0.0'
+end

data/spec/filter_email_spec.rb

@@ -0,0 +1,17 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'filters/email'
+
+describe Filter::Email do
+  it "should convert URIs to clickable anchor tags" do
+    string = 'my email is tj@vision-media.ca'
+    Filter::Email(string).
+    should == 'my email is <a href="mailto:tj@vision-media.ca">tj@vision-media.ca</a>'
+  end
+  
+  it "should retain whitespace" do
+    string = 'email tj@vision-media.ca for awesome web-dev'
+    Filter::Email(string).
+    should == 'email <a href="mailto:tj@vision-media.ca">tj@vision-media.ca</a> for awesome web-dev'    
+  end
+end

data/spec/filter_markup_spec.rb

@@ -0,0 +1,98 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'filters/markup'
+
+describe Filter::Markup do
+  it "should treat *STR* as strong" do
+    Filter::Markup('this *is* sweet').should == 'this <strong>is</strong> sweet'
+    Filter::Markup('this *is sweet').should == 'this *is sweet'
+  end
+  
+  it "should treat /STR/ as em" do
+    Filter::Markup('this /is/ sweet').should == 'this <em>is</em> sweet'
+    Filter::Markup('this /is sweet').should == 'this /is sweet'
+  end
+  
+  it "should treat _STR_ as sub" do
+    Filter::Markup('this _is_ sweet').should == 'this <sub>is</sub> sweet'
+    Filter::Markup('this _is sweet').should == 'this _is sweet'
+  end
+  
+  it "should treat -STR- as sup" do
+    Filter::Markup('this -is- sweet').should == 'this <sup>is</sup> sweet'
+    Filter::Markup('this -is sweet').should == 'this -is sweet'
+  end
+  
+  it "should treat 'STR':URI as an anchor tag" do
+    Filter::Markup('visit "Vision Media":http://vision-media.ca').should == 'visit <a href="http://vision-media.ca">Vision Media</a>'
+    Filter::Markup('visit \'Vision Media\':http://vision-media.ca').should == 'visit <a href="http://vision-media.ca">Vision Media</a>'
+  end
+  
+  it "should treat 'STR':EMAIL as a mailto anchor tag" do
+    Filter::Markup('visit "Vision Media":tj@vision-media.ca').should == 'visit <a href="mailto:tj@vision-media.ca">Vision Media</a>'
+    Filter::Markup('visit \'Vision Media\':tj@vision-media.ca').should == 'visit <a href="mailto:tj@vision-media.ca">Vision Media</a>'
+  end
+  
+  it "should treat @@@ LANG as code" do
+    string = <<-EOF
+      @@@ javascript
+        foo = function(){
+          bar()
+        }
+      @@@
+    EOF
+    
+    expected = <<-EOF
+      <code class="javascript">
+        foo = function(){
+          bar()
+        }
+      </code>
+    EOF
+    
+    Filter::Markup(string).should == expected
+  end
+  
+  it "should treat @@@ as pre" do
+    string = <<-EOF
+      @@@
+        foo = function(){
+          bar()
+        }
+      @@@
+    EOF
+    
+    expected = <<-EOF
+      <pre>
+        foo = function(){
+          bar()
+        }
+      </pre>
+    EOF
+    
+    Filter::Markup(string).should == expected
+  end
+  
+  it "should treat =, ==, h1., h2. etc as headings" do
+    string = <<-EOF
+      = Welcome
+      == Article
+      === Sub Article
+    EOF
+    
+    string2 = <<-EOF
+      h1. Welcome
+      h2. Article
+      h3. Sub Article
+    EOF
+        
+    expected = <<-EOF
+<h1>Welcome</h1>
+<h2>Article</h2>
+<h3>Article</h3>
+    EOF
+    
+    Filter::Markup(string).should == expected
+    Filter::Markup(string2).should == expected
+  end
+end

data/spec/filter_phrase_spec.rb

@@ -0,0 +1,44 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'filters/phrase'
+
+describe Filter::Phrase do
+  it "should not modify the string when no phrases are passed" do
+    string = 'everything is good here!'
+    Filter::Phrase(string).should == string
+  end
+  
+  it "should remove phrases by default" do
+    string = 'fuck! this is so fucking awesome! fuck fuck'
+    result = Filter::Phrase(string, :phrases => %w( fucking fuck ))
+    result.should == 'fuck! this is so awesome!'
+  end
+  
+  it "should substitute with an optional mask" do
+    string = 'fuck! this is so fucking awesome! fuck fuck'
+    result = Filter::Phrase(string, :phrases => %w( fucking fuck ), :mask => '*')
+    result.should == 'fuck! this is so ******* awesome! **** ****'    
+  end
+  
+  it "should substitute with associated masks" do
+    string = 'fuck! this is so fucking awesome! fuck shit'
+    result = Filter::Phrase(string, :phrases => [
+      [:fucking, '[bad]'],
+      [:fuck, '%'],
+      :shit
+    ], :mask => '*')
+    result.should == 'fuck! this is so [bad] awesome! %%%% ****'    
+  end
+  
+  it "should allow literal regexps" do
+    string = 'fuck! fuck fucking'
+    result = Filter::Phrase(string, :phrases => [/fuck(ing|!)?/])
+    result.should be_empty
+  end
+  
+  it "should allow regexp-like strings" do
+    string = 'fuck! fuck fucking'
+    result = Filter::Phrase(string, :phrases => ['fuck(ing|!)?'])
+    result.should be_empty
+  end
+end

data/spec/filter_profanity_spec.rb

@@ -0,0 +1,11 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'filters/profanity'
+
+describe Filter::Profanity do
+  it "should remove profanity" do
+    string = 'fuck this shit is so awesome i just fucking! love it cock bitch slut'
+    results = Filter::Profanity(string, :phrases => %w( fucking! ) )
+    results.should == 'this is so awesome i just love it'
+  end
+end

data/spec/filter_uri_spec.rb

@@ -0,0 +1,27 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+require 'filters/uri'
+
+describe Filter::URI do
+  it "should return string when no uris are present" do
+    Filter::URI('foo bar').should == 'foo bar'  
+  end
+  
+  it "should convert URIs to clickable anchor tags" do
+    string = 'hey check out http://vision-media.ca'
+    Filter::URI(string).
+    should == 'hey check out <a href="http://vision-media.ca">http://vision-media.ca</a>'
+  end
+  
+  it "should optionally open in a new window" do
+    string = 'hey check out http://vision-media.ca'
+    Filter::URI(string, :new_window => true).
+    should == 'hey check out <a href="http://vision-media.ca" target="_blank">http://vision-media.ca</a>'
+  end
+  
+  it "should retain whitespace" do
+    string = 'goto ftp://foo.com to do stuff'
+    Filter::URI(string).
+    should == 'goto <a href="ftp://foo.com">ftp://foo.com </a>to do stuff' 
+  end
+end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'filters'

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: filters
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Text filters including phrases, profanity, mini-markdown, uri, email, etc
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/filters.rb
+- lib/filters/all.rb
+- lib/filters/email.rb
+- lib/filters/filter.rb
+- lib/filters/markup.rb
+- lib/filters/phrase.rb
+- lib/filters/profanity.rb
+- lib/filters/uri.rb
+- lib/filters/version.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- History.rdoc
+- Manifest
+- README.rdoc
+- Rakefile
+- filters.gemspec
+- lib/filters.rb
+- lib/filters/all.rb
+- lib/filters/email.rb
+- lib/filters/filter.rb
+- lib/filters/markup.rb
+- lib/filters/phrase.rb
+- lib/filters/profanity.rb
+- lib/filters/uri.rb
+- lib/filters/version.rb
+- spec/filter_email_spec.rb
+- spec/filter_markup_spec.rb
+- spec/filter_phrase_spec.rb
+- spec/filter_profanity_spec.rb
+- spec/filter_uri_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+has_rdoc: true
+homepage: http://github.com/visionmedia/filters
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Filters
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: filters
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Text filters including phrases, profanity, mini-markdown, uri, email, etc
+test_files: []
+