rspec-cleverbacktrace 0.1

data/doc/README

@@ -0,0 +1,2 @@
+== This is a Really Cool Ruby Thing
+=== ( That deserves better documentation than this. )

data/doc/Specifications

@@ -0,0 +1,10 @@
+
+Spec::Runner::CleverBacktraceTweaker
+- should trim empty backtraces
+- should trim single line backtraces
+- should trim single file backtraces
+- should trim multi file backtraces
+
+Finished in 0.01455 seconds
+
+4 examples, 0 failures

data/lib/cbt-tweaker.rb

@@ -0,0 +1,30 @@
+require 'rspec/backtrace/clever-tweaker'
+
+# RSpec is great, but sometimes you'd like to know a little bit more than the 
+# default about exceptions that get raised during a run.  That's what this 
+# little beggar is supposed to be about: it presents a limited backtrace, that 
+# still includes lines within your code (which is presumed to be in ./lib)
+#
+# To use it, add these options to spec, however you run it:
+#
+#  spec -r cbt-tweaker -b spec
+#
+# What these do:
+#
+#  -r cbt-tweaker  # ("hey, that's me!") so that spec will require this file
+#  -b  # turns on "Noisy" backtraces, which Clever impersonates
+#
+# == To Do
+#
+# So many things - this thing is certainly not _done._  Specifically
+#
+# * Ironically, the tests suck
+# * Don't do nasty interposition tricksies
+# * Lobby for changes to RSpec to allow the previous
+#
+
+
+class Spec::Runner::OptionParser
+  #This is the least bad of many bad choices
+  NoisyBacktraceTweaker = ::Spec::Runner::CleverBacktraceTweaker
+end

data/lib/rspec/backtrace/clever-tweaker.rb

@@ -0,0 +1,82 @@
+module Spec
+  module Runner
+    class CleverBacktraceTweaker < BacktraceTweaker
+      DefaultIgnorePatterns = [
+        %r{/rspec-[^/]*/lib/spec/},
+        %r{/spork-[^/]*/lib/spork/},
+        %r{/lib/ruby/},
+        %r{bin/spec:},
+        %r{bin/spork:},
+        %r{bin/rcov:},
+        %r{lib/rspec-rails},
+        %r{vendor/rails},
+        # TextMate's Ruby and RSpec plugins
+        %r{Ruby\.tmbundle/Support/tmruby.rb:},
+        %r{RSpec\.tmbundle/Support/lib},
+        %r{temp_textmate\.},
+        %r{mock_frameworks/rspec},
+        %r{spec_server%}
+      ]
+
+      def initialize(*patterns)
+        @ignore_patterns = []
+      end
+
+      def clean_up_double_slashes(line)
+        line.gsub!('//','/')
+      end
+
+      def ignore_patterns(*patterns)
+        @ignore_patterns += patterns
+      end
+
+      def ignored_patterns
+        DefaultIgnorePatterns + @ignore_patterns
+      end
+
+      def tweak_backtrace(error)
+        return if error.backtrace.nil?
+        tweaked = error.backtrace.collect do |message|
+          clean_up_double_slashes(message)
+          kept_lines = message.split("\n").select do |line|
+            ignored_patterns.each do |ignore|
+              break if line =~ ignore
+            end
+          end
+          kept_lines.empty?? nil : kept_lines.join("\n")
+        end.compact
+
+        tweaked.map! do |line|
+          line = line.split(/:/)
+          [File::expand_path(line[0]).split(File::Separator)] + line[1..-1]
+        end
+        
+        bedrock = Dir::pwd.split(File::Separator)
+        bedrock.shift
+        prefix = ((tweaked.first||[]).first||[]).first
+        until tweaked.find {|line| line.first.first != prefix}
+          tweaked.map! do |line|
+            [(line[0])[1..-1]] + line[1..-1]
+          end
+          break if bedrock.shift.nil?
+          prefix = ((tweaked.first||[]).first||[]).first
+        end
+
+        paths_seen = {}
+        result = []
+        jump_header = ' \> '
+        tweaked.each do |line|
+          if paths_seen.has_key?(line.first)
+            result.last << paths_seen[line.first].to_s
+          else
+            index = paths_seen.keys.length + 1
+            result << "#{index} " + ([File::join(*line[0])] + line[1..-1]).join(":")
+            result << jump_header.dup
+            paths_seen[line.first] = index
+          end
+        end
+        error.set_backtrace(result.find_all{|line| line != jump_header})
+      end
+    end
+  end
+end

data/spec/clever-tweaker.rb

@@ -0,0 +1,48 @@
+require 'rspec/backtrace/clever-tweaker'
+
+describe Spec::Runner::CleverBacktraceTweaker do
+  before do
+    @exception = Exception.new
+    @tweaker = Spec::Runner::CleverBacktraceTweaker.new
+  end
+
+  it "should trim empty backtraces" do
+    @exception.set_backtrace([])
+    @tweaker.tweak_backtrace(@exception)
+    @exception.backtrace.should == []
+  end
+
+  it "should trim single line backtraces" do
+    @exception.set_backtrace([Dir::pwd + "/some/crazy/file.rb:5:in a bad place"])
+    @tweaker.tweak_backtrace(@exception)
+    @exception.backtrace.should == ["1 some/crazy/file.rb:5:in a bad place"]
+  end
+
+  it "should trim single file backtraces" do
+    file = Dir::pwd + "/some/file.rb"
+    @exception.set_backtrace([
+    file + ":1:in x",
+    file + ":2:in y",
+    file + ":3:in z"
+    ])
+    @tweaker.tweak_backtrace(@exception)
+    @exception.backtrace.should == [
+    "1 some/file.rb:1:in x", 
+    ' \> 11'
+    ]
+  end
+
+  it "should trim multi file backtraces" do
+    @exception.set_backtrace([
+    "../../a/crazy/file:1:in x",
+    "../../a/crazy/other:2:in y",
+    "../../a/different/file:3:in z"
+    ])
+    @tweaker.tweak_backtrace(@exception)
+    @exception.backtrace.should == [
+    "1 crazy/file:1:in x",
+    "2 crazy/other:2:in y",
+    "3 different/file:3:in z"
+    ]
+  end
+end

data/spec_help/gem_test_suite.rb

@@ -0,0 +1,17 @@
+puts Dir::pwd
+require 'test/unit'
+begin
+  require 'spec'
+rescue LoadError
+  false
+end
+
+class RSpecTest < Test::Unit::TestCase
+  def test_that_rspec_is_available
+    assert_nothing_raised("\n\n *  RSpec isn't available - please run: gem install rspec  *\n\n"){ ::Spec }
+  end
+
+  def test_that_specs_pass
+    assert(system(*%w{spec -f e -p **/*.rb spec}),"\n\n *  Specs failed  *\n\n")
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-cleverbacktrace
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Judson Lester
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: "  The default backtrace handling for rspec is ... okay.  It would be nice if\n  you could find the source of exceptions during test runs without having\n  to see *all* the backtraces, right?\n\n  That's what this thing is for: it compacts backtraces, skims out things that\n  should be ignored (and respects ignore_patterns), then trims filenames and \n  contracts repetition into a legible format.\n"
+email: nyarly@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- doc/README
+- doc/Specifications
+files: 
+- lib/rspec/backtrace/clever-tweaker.rb
+- lib/cbt-tweaker.rb
+- doc/README
+- doc/Specifications
+- spec/clever-tweaker.rb
+has_rdoc: true
+homepage: http://cleverbacktrace.rubyforge.org/
+licenses: []
+
+post_install_message: Another tidy package brought to you by Judson
+rdoc_options: 
+- --inline-source
+- --main
+- doc/README
+- --title
+- rspec-cleverbacktrace-0.1 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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: cleverbacktrace
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A backtrace tweaker too clever for its own good
+test_files: 
+- spec_help/gem_test_suite.rb