filters 1.0.1 → 1.1.0

data/Manifest

@@ -19,6 +19,3 @@ 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

@@ -9,6 +9,16 @@ Ruby text filters consisting of the following core filters:
 * uri (converts uris to anchor tags)
 * markup (mini-markup language)
 
+== Mutative
+
+All filters return a new string by default, however when you bang! it, the
+string object initially passed will be modified. This method is often ideal, 
+as it is easier to chain filters together.
+
+  Filter::Profanity!(text)
+  Filter::Email!(text)
+  ...
+
 == Filter::Phrase
 
   Filter::Phrase('bad word!', :phrases => ['bad'])
@@ -40,12 +50,12 @@ Ruby text filters consisting of the following core filters:
 == Filter::URI
 
   Filter::URI('hey checkout http://vision-media.ca sometime')
-  # => 'hey checkout <a href="http://vision-media.ca">sometime</a>'
+  # => 'hey checkout <a href="http://vision-media.ca">http://vision-media.ca</a> sometime'
   
 == Filter::Email
 
   Filter::Email('hey email me@foo.com sometime')
-  # => 'hey email <a href="mailto:me@foo.com">sometime</a> sometime'
+  # => 'hey email <a href="mailto:me@foo.com">me@foo.com</a> sometime'
   
 == Filter::Markup
 

data/Rakefile

@@ -13,4 +13,4 @@ Echoe.new "filters", Filter::VERSION do |p|
   p.runtime_dependencies = []
 end
 
-Dir['tasks/**/*.rake'].sort.each { |f| load f }
+task :gemspec => [:build_gemspec]

data/filters.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{filters}
-  s.version = "1.0.1"
+  s.version = "1.1.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-23}
+  s.date = %q{2009-11-23}
   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.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"]
+  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"]
   s.homepage = %q{http://github.com/visionmedia/filters}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Filters", "--main", "README.rdoc"]
   s.require_paths = ["lib"]

data/lib/filters/all.rb

@@ -1,6 +1,2 @@
 
-require 'filters/phrase'
-require 'filters/profanity'
-require 'filters/markup'
-require 'filters/email'
-require 'filters/uri'
+warn "require 'filters/all' is deprecated; all filters are auto-loaded"

data/lib/filters/filter.rb

@@ -13,14 +13,34 @@ class Filter
     @string, @options = string, options
   end
   
+  ##
+  # Non-mutative filter.
+  
+  def filter
+    @string = string.dup and filter!
+  end
+  
   ##
   # Auto generate Filter::Subclass() methods which
-  # act as a shortcut to Filter::Subclass.new(...).filter!
+  # 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
+    (class << self; self end).send :define_method, subclass.name.split('::').last + '!' do |*args|
       subclass.new(*args).filter!
     end
   end
   
+  #--
+  # Autoloading
+  #++
+  
+  autoload :URI, 'filters/uri'
+  autoload :Email, 'filters/email'
+  autoload :Markup, 'filters/markup'
+  autoload :Phrase, 'filters/phrase'
+  autoload :Profanity, 'filters/profanity'
+  
 end

data/lib/filters/profanity.rb

@@ -1,6 +1,4 @@
 
-require 'filters/phrase'
-
 class Filter
   class Profanity < Phrase
     
@@ -300,7 +298,11 @@ class Filter
     
   end
   
-  def self.Profanity *args
+  def self.Profanity! *args
     Profanity.new(*args).filter!
   end
+    
+  def self.Profanity *args
+    Profanity.new(*args).filter
+  end
 end

data/lib/filters/uri.rb

@@ -1,3 +1,4 @@
+require 'uri/common'
 
 class Filter
   class URI < self
@@ -17,13 +18,13 @@ class Filter
     
     ##
     # Convert URIs to anchor tags.
-    
+
     def filter!
-      string.gsub! /\w+:\/\/(.*?)(\s+|$)/ do |uri|
+      string.gsub! ::URI.regexp do |uri|
         if new_window
-          %(<a href="#{uri.strip}" target="_blank">#{uri}</a>)
+          %(<a href="#{uri}" target="_blank">#{uri}</a>)
         else
-          %(<a href="#{uri.strip}">#{uri}</a>)
+          %(<a href="#{uri}">#{uri}</a>)
         end
       end
       string

data/lib/filters/version.rb

@@ -1,4 +1,4 @@
 
 class Filter
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/filter_email_spec.rb

@@ -1,6 +1,5 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
-require 'filters/email'
 
 describe Filter::Email do
   it "should convert URIs to clickable anchor tags" do
@@ -12,6 +11,22 @@ describe Filter::Email do
   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'    
+    should == 'email <a href="mailto:tj@vision-media.ca">tj@vision-media.ca</a> for awesome web-dev'
+  end
+  
+  it "should not mutate the string passed" do
+    string = 'email tj@vision-media.ca for awesome web-dev'
+    Filter::Email(string)
+    string.should == 'email tj@vision-media.ca for awesome web-dev'
+  end
+  
+  it "should mutate when bang is used" do
+    string = 'email tj@vision-media.ca for awesome web-dev'
+    Filter::Email!(string)
+    string.should == 'email <a href="mailto:tj@vision-media.ca">tj@vision-media.ca</a> for awesome web-dev'
+  end
+  
+  it "should return the string untouched when no emails are present" do
+    Filter::Email('foo bar').should == 'foo bar'
   end
 end

data/spec/filter_markup_spec.rb

@@ -1,6 +1,5 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
-require 'filters/markup'
 
 describe Filter::Markup do
   it "should treat *STR* as strong" do
@@ -96,4 +95,20 @@ describe Filter::Markup do
     filtered2.should include('<h2>Article</h2>')
     filtered2.should include('<h3>Sub Article</h3>')
   end
+  
+  it "should not mutate the string passed" do
+    string = 'foo *bar*'
+    Filter::Markup(string)
+    string.should == 'foo *bar*'
+  end
+  
+  it "should mutate when a bang is used" do
+    string = 'foo *bar*'
+    Filter::Markup!(string)
+    string.should == 'foo <strong>bar</strong>'    
+  end
+  
+  it "should return the string untouched when no conversion are present" do
+    Filter::Markup('foo bar').should == 'foo bar'
+  end
 end

data/spec/filter_phrase_spec.rb

@@ -1,11 +1,9 @@
 
 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
+    Filter::Phrase('everything is good here!').should == 'everything is good here!'
   end
   
   it "should remove phrases by default" do
@@ -41,4 +39,16 @@ describe Filter::Phrase do
     result = Filter::Phrase(string, :phrases => ['fuck(ing|!)?'])
     result.should be_empty
   end
+  
+  it "should not mutate the string passed" do
+    string = 'fuck fuck!'
+    Filter::Phrase(string, :phrases => ['fuck'])
+    string.should == 'fuck fuck!'
+  end
+  
+  it "should mutate when a bang is used" do
+    string = 'fuck fuck!'
+    Filter::Phrase!(string, :phrases => ['fuck'])
+    string.should == 'fuck!'
+  end
 end

data/spec/filter_profanity_spec.rb

@@ -1,6 +1,5 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
-require 'filters/profanity'
 
 describe Filter::Profanity do
   it "should remove profanity" do
@@ -8,4 +7,20 @@ describe Filter::Profanity do
     results = Filter::Profanity(string, :phrases => %w( fucking! ) )
     results.should == 'this is so awesome i just love it'
   end
+  
+  it "should return the string untouched when no profanity is present" do
+    Filter::Markup('foo bar').should == 'foo bar'
+  end
+  
+  it "should not mutate the string passed" do
+    string = 'fuck this shit'
+    Filter::Profanity(string)
+    string.should == 'fuck this shit'
+  end
+  
+  it "should mutate when a bang is used" do
+    string = 'fuck this shit'
+    Filter::Profanity!(string)
+    string.strip.should == 'this'
+  end
 end

data/spec/filter_uri_spec.rb

@@ -1,6 +1,5 @@
 
 require File.dirname(__FILE__) + '/spec_helper'
-require 'filters/uri'
 
 describe Filter::URI do
   it "should return string when no uris are present" do
@@ -22,6 +21,18 @@ describe Filter::URI do
   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' 
+    should == 'goto <a href="ftp://foo.com">ftp://foo.com</a> to do stuff'
+  end
+  
+  it "should not mutate the string passed" do
+    string = 'goto ftp://foo.com to do stuff'
+    Filter::URI(string)
+    string.should == 'goto ftp://foo.com to do stuff'
+  end
+  
+  it "should mutate when a bang is used" do
+    string = 'goto ftp://foo.com to do stuff'
+    Filter::URI!(string)
+    string.should == 'goto <a href="ftp://foo.com">ftp://foo.com</a> to do stuff'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: filters
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors: 
 - TJ Holowaychuk
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-23 00:00:00 -07:00
+date: 2009-11-23 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -30,9 +30,6 @@ extra_rdoc_files:
 - 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
@@ -55,9 +52,6 @@ files:
 - 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: []

data/tasks/docs.rake

@@ -1,13 +0,0 @@
-
-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

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

data/tasks/spec.rake

@@ -1,25 +0,0 @@
-
-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