@@ -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 MIT-LICENSE @@ -12,26 +12,16 @@ sudo gem install thoughtbot-quietbacktrace --source=http://gems.github.com Usage ----- -Silencers remove lines from the backtrace that return true for given conditions. -Filters modify the output of backtrace lines. - -Override the defaults by adding your own backtrace_silencers: +Silencers remove lines from the backtrace. Create your own: 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: +Filters modify the output of backtrace lines. Create your own: 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: @@ -41,20 +31,6 @@ Turn Quiet Backtrace off anywhere in your test suite by setting the flag to fals 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. README.markdown @@ -1,23 +1,44 @@ require 'test/unit' +require 'cattr_accessor' +require File.join(File.dirname(__FILE__), 'backtrace_cleaner') -def mix_cleaner_into_test_unit - require File.join(File.dirname(__FILE__), 'quietbacktrace', 'cleaner') +module QuietBacktrace + module TestCase + def self.included(klass) + klass.class_eval do + cattr_accessor :quiet_backtrace + self.quiet_backtrace = true + end + end + end - Test::Unit::Util::BacktraceFilter.module_eval do - include QuietBacktrace::CleanerForTestUnit + module CleanerForTestUnit + def self.included(klass) + klass.send :alias_method, :filter_backtrace_without_cleaning, :filter_backtrace + klass.send :alias_method, :filter_backtrace, :filter_backtrace_with_cleaning + end + + def filter_backtrace_with_cleaning(backtrace) + backtrace = filter_backtrace_without_cleaning(backtrace) + backtrace = backtrace.first.split("\n") if backtrace.size == 1 + cleaner = QuietBacktrace::BacktraceCleaner.new + cleaner.clean(backtrace) + end end end -def mix_rails_cleaner_into_test_unit - require File.join(File.dirname(__FILE__), 'quietbacktrace', 'rails', 'cleaner') - +Test::Unit::TestCase.class_eval { include QuietBacktrace::TestCase } + +if Test::Unit::TestCase.quiet_backtrace Test::Unit::Util::BacktraceFilter.module_eval do - include QuietBacktrace::Rails::CleanerForTestUnit + include QuietBacktrace::CleanerForTestUnit end end -if defined?(Rails) - mix_rails_cleaner_into_test_unit -else - mix_cleaner_into_test_unit -end +# module Rails +# def backtrace_cleaner +# @@backtrace_cleaner ||= begin +# QuietBacktrace::BacktraceCleaner.new +# end +# end +# end lib/quietbacktrace.rb @@ -4,43 +4,22 @@ class Test::Unit::TestCase def setup @backtrace = [ "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:48:in `assert_block'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:495:in `_wrap_assertion'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:46:in `assert_block'", "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/assertions.rb:313:in `flunk'", "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/benchmark.rb:293", "/Users/james/Documents/railsApps/generating_station/app/controllers/photos_controller.rb:315:in `something'", "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/test/quiet_stacktraces_test.rb:21:in `test_this_plugin'", - "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/quiet_stacktraces_test.rb:25:in `test_this_plugin'", "/Library/Ruby/Gems/1.8/gems/activerecord-1.99.0/lib/active_record/connection_adapters/mysql_adapter.rb:471:in `real_connect'", - "/Library/Ruby/Gems/1.8/gems/activerecord-1.99.0/lib/active_record/fixtures.rb:895:in `teardown'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnermediator.rb:46:in `run_suite'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:67:in `start_mediator'", "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/console/testrunner.rb:41:in `start'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/ui/testrunnerutilities.rb:29:in `run'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:216:in `run'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/autorunner.rb:12:in `run'", "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit.rb:278", "/Users/james/Documents/railsApps/generating_station/vendor/plugins/quiet_stacktraces/test/quiet_stacktraces_test.rb:20", "/app/controllers/blogs_controller.rb:5:in `index'", - "thin (0.6.4) lib/thin/connection.rb:35:in `process'", - "thin (0.6.4) lib/thin/connection.rb:23:in `receive_data'", - "eventmachine (0.10.0) lib/eventmachine.rb:1056:in `event_callback'", - "eventmachine (0.10.0) lib/eventmachine.rb:224:in `run_machine'", - "eventmachine (0.10.0) lib/eventmachine.rb:224:in `run'", - "thin (0.6.4) lib/thin/server.rb:113:in `start'", - "thin (0.6.4) lib/thin/controllers/controller.rb:59:in `start'", - "thin (0.6.4) lib/thin/runner.rb:143:in `send'", - "thin (0.6.4) lib/thin/runner.rb:143:in `run_command'", - "thin (0.6.4) lib/thin/runner.rb:114:in `run!'", - "thin (0.6.4) bin/thin:6", - "/opt/local/bin/thin:16:in `load'", - "/opt/local/bin/thin:16", - "/Users/dancroak/dev/nationalgazette/vendor/gems/thoughtbot-shoulda-2.0.6/lib/shoulda/controller/macros.rb:193:in `__bind_1230852072_504846'", - "/Users/dancroak/dev/nationalgazette/vendor/gems/thoughtbot-shoulda-2.0.6/lib/shoulda/context.rb:254:in `call'", "/Users/dancroak/dev/nationalgazette/vendor/gems/thoughtbot-shoulda-2.0.6/lib/shoulda/context.rb:254:in `test: on a GET to #index.rss should respond with content type of application/rs+xml. '", "/Users/dancroak/dev/nationalgazette/vendor/rails/activesupport/lib/active_support/testing/setup_and_teardown.rb:94:in `__send__'", "/Users/dancroak/dev/nationalgazette/vendor/rails/activesupport/lib/active_support/testing/setup_and_teardown.rb:94:in `run'", - "/System/Library/Frameworks/Ruby.framework/Versions/1.8/usr/lib/ruby/1.8/test/unit/testsuite.rb:34:in `run'"] + "lib/mongrel", "bin/mongrel", + "lib/passenger", "bin/passenger-spawn-server", + "lib/rack", "script/server", + "rubygems/custom_require", "benchmark.rb"] end # test "verify something" do test/test_helper.rb lib/quietbacktrace/cleaner.rb lib/quietbacktrace/rails/cleaner.rb test/cleaner_test.rb test/rails_cleaner_test.rb 294359c371749cbacaefaade3d99359f86936e0b Dan Croak dcroak@thoughtbot.com http://github.com/thoughtbot/quietbacktrace/commit/6f3eb93fc139dced52f5b83176f49e36ee5b581e 6f3eb93fc139dced52f5b83176f49e36ee5b581e 2009-01-01T20:54:55-08:00 2009-01-01T20:54:55-08:00 experiment with turning quiet backtrace off d004b3a2de5cc7b3061454da0bd06254e04d1752 Dan Croak dcroak@thoughtbot.com