thoughtbot-quietbacktrace 1.1.5 → 1.1.6

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007 Dan Croak, thoughtbot, inc.
+Copyright (c) 2009 Dan Croak, thoughtbot, inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -12,70 +12,27 @@ sudo gem install thoughtbot-quietbacktrace --source=http://gems.github.com
 Usage
 -----
 
-Quiet Backtrace works by adding new attributes to Test::Unit::TestCase. 
-By default, their values are: 
+Silencers remove lines from the backtrace. Create your own:
 
-    self.quiet_backtrace = true
-    self.backtrace_silencers = [:test_unit, :gem_root, :e1]
-    self.backtrace_filters = [:method_name]
+    # Will reject all lines that include the word "mongrel", 
+    # like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
+    backtrace_cleaner = QuietBacktrace.BacktraceCleaner.new
+    backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
 
-Silencers remove lines from the backtrace that return true for given conditions.
-Filters modify the output of backtrace lines.
+Filters modify the output of backtrace lines. Create your own:
 
-Override the defaults by adding your own backtrace_silencers:
-
-    class Test::Unit::TestCase
-  	  self.new_backtrace_silencer :shoulda do |line| 
-        line.include? 'vendor/plugins/shoulda'
-      end
-      self.backtrace_silencers << :shoulda
-    end
-
-Or your own backtrace_filters:
-
-    class Test::Unit::TestCase
-      self.new_backtrace_filter :ruby_path do |line|
-         ruby_file_path = '/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8'
-         line.slice!(0..(line =~ ruby_file_path)) if (line =~ ruby_file_path)
-      end
-      self.backtrace_filters << :ruby_path
-    end
-
-Turn Quiet Backtrace off anywhere in your test suite by setting the flag to false:
-
-    Test::Unit::TestCase.quiet_backtrace = false
-
-Rails-specific usage
---------------------
-
-Install the gem and add it your Rails app:
-
-* gem install thoughtbot-quietbacktrace --source http://gems.github.com
-* cd vendor/gems
-* gem unpack quietbacktrace
-
-Quiet Backtrace comes with an excellent Rails-specific silencer and filter.
-They must be added (usually in test_helper.rb) because they are not turned on by default:
-
-    class Test::Unit::TestCase
-      self.backtrace_silencers << :rails_vendor
-      self.backtrace_filters   << :rails_root
-    end
-
-Because Quiet Backtrace works by adding attributes onto Test::Unit::TestCase,
-you can add and remove silencers and filters at any level in your test suite,
-down to the individual test. 
+    # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+    backtrace_cleaner = QuietBacktrace.BacktraceCleaner.new
+    backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
 
 Requirements
 ------------
 
 * Test::Unit 
-* ActiveSupport (alias method chain, cattr accessor, & mattr accessor)
 
 Resources
 ---------
 
-* [mailing list](http://groups.google.com/group/quiet_backtrace)
 * [project site](http://github.com/thoughtbot/quietbacktrace)
 
 Authors

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'date'
+
+desc "Run the test suite"
+task :default => :test
+
+desc 'Test the quietbacktrace gem.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+gem_spec = Gem::Specification.new do |gem_spec|
+  gem_spec.name        = "quietbacktrace"
+  gem_spec.version     = "1.1.6"
+  gem_spec.summary     = "Suppresses the noise in your Test::Unit backtraces."
+  gem_spec.email       = "support@thoughtbot.com"
+  gem_spec.homepage    = "http://github.com/thoughtbot/quietbacktrace"
+  gem_spec.description = "Silence or filter lines of your backtrace programatically."
+  gem_spec.authors     = ["thoughtbot, inc.", "Dan Croak", "James Golick", 
+                          "Mike Burns", "Joe Ferris", "Boston.rb"] 
+  gem_spec.files       = FileList["[A-Z]*", "{lib}/**/*"]
+end
+
+desc "Generate a gemspec file"
+task :gemspec do
+  File.open("#{gem_spec.name}.gemspec", 'w') do |f|
+    f.write gem_spec.to_yaml
+  end
+end
+

data/lib/backtrace_cleaner.rb

@@ -0,0 +1,100 @@
+module QuietBacktrace
+  class BacktraceCleaner
+    
+    RUBY_NOISE       = %w( ruby Ruby.framework 
+                           rubygems/custom_require benchmark.rb )
+    TEST_UNIT_NOISE  = %w( test/unit )
+    GEM_NOISE        = %w( -e:1 )
+
+    SHOULDA_NOISE    = %w( shoulda )
+
+    RAILS_NOISE = %w( script/server lib/active_record )
+    VENDOR_DIRS = %w( vendor/gems vendor/rails vendor/plugins )
+    SERVER_DIRS = %w( lib/mongrel bin/mongrel
+                      lib/passenger bin/passenger-spawn-server
+                      lib/rack )
+    
+    ERB_METHOD_SIG = /:in `_run_erb_.*/
+    
+    ALL_NOISE = RUBY_NOISE  + TEST_UNIT_NOISE + GEM_NOISE + SHOULDA_NOISE +
+                RAILS_NOISE + VENDOR_DIRS     + SERVER_DIRS 
+    
+    def initialize
+      @filters, @silencers = [], []
+      
+      if defined?(RAILS_ROOT)
+        add_filter { |line| line.sub("#{RAILS_ROOT}/", '') }
+      end
+      
+      add_filter { |line| line.sub(ERB_METHOD_SIG, '') }
+      add_filter { |line| line.sub('./', '/') }
+      
+      if defined?(Gem)
+        add_filter do |line| 
+          line.sub(/(#{Gem.default_dir})\/gems\/([a-z]+)-([0-9.]+)\/(.*)/, '\2 (\3) \4') 
+        end
+      end
+
+      add_silencer { |line| ALL_NOISE.any? { |dir| line.include?(dir) } }
+    end
+    
+    # Returns the backtrace after all filters and silencers has been run against it. 
+    # Filters run first, then silencers.
+    def clean(backtrace)
+      silence(filter(backtrace))
+    end
+ 
+    # Adds a filter from the block provided. 
+    # Each line in the backtrace will be mapped against this filter.
+    #
+    # Example:
+    #
+    # Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
+    # 
+    # backtrace_cleaner = QuietBacktrace.BacktraceCleaner.new
+    # backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') }
+    def add_filter(&block)
+      @filters << block
+    end
+ 
+    # Adds a silencer from the block provided. If the silencer returns true for a given line, it'll be excluded from the
+    # quiet backtrace.
+    #
+    # Example:
+    #
+    # Will reject all lines that include the word "mongrel", 
+    # like "/gems/mongrel/server.rb" or "/app/my_mongrel_server/rb"
+    # 
+    # backtrace_cleaner = QuietBacktrace.BacktraceCleaner.new
+    # backtrace_cleaner.add_silencer { |line| line =~ /mongrel/ }
+    def add_silencer(&block)
+      @silencers << block
+    end
+ 
+    # Will remove all silencers, but leave in the filters. 
+    # This is useful if your context of debugging suddenly expands as
+    # you suspect a bug in the libraries you use.
+    def remove_silencers!
+      @silencers = []
+    end
+    
+    private
+    
+      def filter(backtrace)
+        @filters.each do |f|
+          backtrace = backtrace.map { |line| f.call(line) }
+        end
+        
+        backtrace
+      end
+      
+      def silence(backtrace)
+        @silencers.each do |s|
+          backtrace = backtrace.reject { |line| s.call(line) }
+        end
+        
+        backtrace
+      end
+
+  end
+end

data/lib/quietbacktrace.rb

@@ -1,90 +1,22 @@
 require 'test/unit'
-require 'rubygems'
-require 'activesupport'
+require File.join(File.dirname(__FILE__), 'backtrace_cleaner')
 
-module QuietBacktrace # :nodoc: all
-  module BacktraceFilter
+module QuietBacktrace
+  module CleanerForTestUnit
     def self.included(klass)
-      klass.class_eval { alias_method_chain :filter_backtrace, :quieting }
+      klass.send :alias_method, :filter_backtrace_without_cleaning, :filter_backtrace
+      klass.send :alias_method, :filter_backtrace, :filter_backtrace_with_cleaning
     end
 
-    mattr_accessor :silencers, :filters
-    self.silencers, self.filters = {}, {}
-
-    def filter_backtrace_with_quieting(backtrace)
-      filter_backtrace_without_quieting(backtrace)
-
-      # Rails view backtraces are flattened into one String. Adjust.
+    def filter_backtrace_with_cleaning(backtrace)
+      backtrace = filter_backtrace_without_cleaning(backtrace)
       backtrace = backtrace.first.split("\n") if backtrace.size == 1
-
-      if Test::Unit::TestCase.quiet_backtrace
-        backtrace.reject! do |line|
-          [*Test::Unit::TestCase.backtrace_silencers].any? do |silencer_name|
-            QuietBacktrace::BacktraceFilter.silencers[silencer_name].call(line) if silencer_name
-          end
-        end
-
-        backtrace.each do |line|
-          [*Test::Unit::TestCase.backtrace_filters].each do |filter_name|
-            QuietBacktrace::BacktraceFilter.filters[filter_name].call(line) if filter_name
-          end
-        end          
-      end
-      
-      backtrace
-    end
-  end
-  
-  module TestCase
-    def self.included(klass)
-      klass.class_eval do
-        cattr_accessor :quiet_backtrace, :backtrace_silencers, :backtrace_filters
-        self.backtrace_filters, self.backtrace_silencers = [], []
-        
-        extend ClassMethods
-        
-        new_backtrace_silencer(:test_unit) do |line|
-          (line.include?("ruby") && line.include?("/test/unit"))
-        end
-        new_backtrace_silencer(:os_x_ruby) do |line| 
-          line.include?('Ruby.framework')
-        end
-        new_backtrace_silencer(:gem_root) do |line| 
-          line =~ /ruby\/gems/i
-        end
-        new_backtrace_silencer(:e1) do |line| 
-          line == "-e:1"
-        end
-        new_backtrace_silencer(:rails_vendor) do |line| 
-          (line.include?("vendor/plugins") || 
-            line.include?("vendor/gems") || 
-            line.include?("vendor/rails"))
-        end
-        
-        new_backtrace_filter(:method_name) do |line| 
-          line.slice!((line =~ /:in /)..line.length) if (line =~ /:in /)
-        end
-        new_backtrace_filter(:rails_root) do |line| 
-          line.sub!("#{RAILS_ROOT}/", '') if (defined?(RAILS_ROOT) && line.include?(RAILS_ROOT))
-        end
-        
-        self.quiet_backtrace = true
-        self.backtrace_silencers = [:test_unit, :os_x_ruby, :gem_root, :e1]
-        self.backtrace_filters = [:method_name]
-      end
-    end
-      
-    module ClassMethods
-      def new_backtrace_silencer(symbol, &block)
-        QuietBacktrace::BacktraceFilter.silencers[symbol] = block
-      end
-    
-      def new_backtrace_filter(symbol, &block)
-        QuietBacktrace::BacktraceFilter.filters[symbol] = block
-      end
+      cleaner = QuietBacktrace::BacktraceCleaner.new 
+      cleaner.clean(backtrace)
     end
   end
 end
 
-Test::Unit::Util::BacktraceFilter.module_eval { include QuietBacktrace::BacktraceFilter }
-Test::Unit::TestCase.class_eval { include QuietBacktrace::TestCase }
+Test::Unit::Util::BacktraceFilter.module_eval do 
+  include QuietBacktrace::CleanerForTestUnit 
+end

metadata

@@ -1,22 +1,25 @@
 --- !ruby/object:Gem::Specification 
 name: thoughtbot-quietbacktrace
 version: !ruby/object:Gem::Version 
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors: 
 - thoughtbot, inc.
 - Dan Croak
 - James Golick
+- Mike Burns
+- Joe Ferris
+- Boston.rb
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-02 00:00:00 -07:00
+date: 2009-02-28 21:00:00 -08:00
 default_executable: 
 dependencies: []
 
-description: Quiet Backtrace suppresses the noise in your Test::Unit backtrace. It also provides hooks for you to add additional silencers and filters.
-email: dcroak@thoughtbot.com
+description: Silence or filter lines of your backtrace programatically.
+email: support@thoughtbot.com
 executables: []
 
 extensions: []
@@ -24,9 +27,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- MIT-LICENSE
+- Rakefile
 - README.markdown
+- lib/backtrace_cleaner.rb
 - lib/quietbacktrace.rb
-- MIT-LICENSE
 has_rdoc: false
 homepage: http://github.com/thoughtbot/quietbacktrace
 post_install_message: 
@@ -52,6 +57,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Quiet Backtrace suppresses the noise in your Test::Unit backtrace.
+summary: Suppresses the noise in your Test::Unit backtraces.
 test_files: []