open_exception 0.2.3 → 0.3.0

data/README.md

@@ -18,7 +18,21 @@ Out if the box, the gem supports three editors (with the following open commands
     :textmate => '/usr/local/bin/mate -a -d -l {line} {file}',
     :macvim => '/usr/local/bin/mvim +{line} {file}'
 
-Note: if using emacs, you will need to be running `emacsserver`. To start the server:
+Any of these will open the file and set focus on the editor. `:emacs` is the default.
+
+If you are using emacs, you can also open the backtrace along with the file using `:emacs_with_trace` as the `:open_with` argument. This uses: 
+    /usr/bin/emacsclient -e '(open-trace-and-file "{tracefile}" "{file}" {line})'
+as the open command. To use this, you will need to add the following function to your emacs init:
+
+    (defun open-trace-and-file (tracefile file linenum)
+      "Open visit TRACEFILE in one window (in compilation mode), and visit FILE at LINENUM in another"
+      (find-file-other-window tracefile)
+      (goto-line 2)
+      (compilation-mode)
+      (find-file-other-window file)
+      (goto-line linenum))
+
+Note: for `emacsclient` to work, you will need to be running `emacsserver`. To start the server:
     M-x server-start
 or add the following to your init:
     (server-start)
@@ -29,9 +43,9 @@ Configuration
 To configure, pass a block to the configure method:
     
     OpenException.configure do |oe|
-      # open_with can be one of the built in editors (:emacs, :macvim, :textmate)
-      # or a command to execute to open the file, where {file} and {line} will be replaced
-      # with the file path and line number, respectively. See 'Editors' above for an example.
+      # open_with can be one of the built in editors (:emacs, :emacs_with_trace, :macvim, :textmate)
+      # or a command to execute to open the file, where {file}, {line}, and {tracefile} will be replaced
+      # with the file path, line number, and path to tmp file holding the backtrace, respectively. See 'Editors' above for an example.
       # The default editor is :emacs.
 
       oe.open_with = :emacs

data/VERSION

@@ -1 +1 @@
-0.2.3
+0.3.0

data/lib/open_exception/growl_support.rb

@@ -8,24 +8,22 @@ module OpenException
     end
     
     protected
-    def open_file_with_growl(file, line)
-      puts 'growl open file'
-      growl_notify(file, line) if File.readable?(file)
-      open_file_without_growl(file, line)
+    def open_file_with_growl
+      growl_notify if File.readable?(file_name)
+      open_file_without_growl
     end
     
-    def growl_notify(file, line)
+    def growl_notify
       if Growl.installed?
         Growl.notify do |n|
           n.title = 'Open Exception'
-          n.message = growl_message(file, line)
+          n.message = growl_message
         end
       end
     end
     
-    def growl_message(file, line)
-      msg = "Exception: #{exception.message} at #{exception.backtrace.first}\nOpening #{file}:#{line}"
-      msg << " in #{options[:open_with]}" if options[:open_with].is_a?(Symbol)
+    def growl_message
+      msg = "Exception: #{exception.message} at #{exception.backtrace.first}\nOpening #{file_name}:#{line_number}"
     end
   end
 end

data/lib/open_exception/open_exception.rb

@@ -1,7 +1,10 @@
+require 'tempfile'
+
 module OpenException
 
   EDITOR_COMMANDS = {
     :emacs => '/usr/bin/emacsclient -n +{line} {file}',
+    :emacs_with_trace => '/usr/bin/emacsclient -e \'(open-trace-and-file "{tracefile}" "{file}" {line})\'',
     :textmate => '/usr/local/bin/mate -a -d -l {line} {file}',
     :macvim => '/usr/local/bin/mvim +{line} {file}'
   }
@@ -40,19 +43,17 @@ module OpenException
     end
 
     def open
-      if !exclude_exception?
-        file_and_line = extract_file_and_line
-        open_file(*file_and_line) if file_and_line
-      end
+      extract_file_and_line && open_file unless exclude_exception?
     end
 
     protected
-    attr_reader :exception
+    attr_reader :exception, :file_name, :line_number
 
     def extract_file_and_line
       if exception.backtrace and
           filter_backtrace(exception.backtrace) =~ /(.*?):(\d*)/
-        [$1, $2]
+        @file_name = $1
+        @line_number = $2
       end
     end
 
@@ -92,10 +93,17 @@ module OpenException
       end
     end
 
-    def open_file(file_name, line_number)
+    def open_file
       if File.readable?(file_name)
         cmd = open_command.gsub('{file}', file_name).gsub('{line}', line_number)
-        puts cmd
+        if cmd =~ /\{tracefile\}/
+          Tempfile.open('open_exception-trace') do |f|
+            f << exception.message
+            f << "\n"
+            f << exception.backtrace.join("\n")
+            cmd.gsub!('{tracefile}', f.path)
+          end
+        end
         system(cmd)
       end
     end

data/open_exception.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{open_exception}
-  s.version = "0.2.3"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Crawley"]
-  s.date = %q{2010-04-29}
+  s.date = %q{2010-05-15}
   s.description = %q{}
   s.email = %q{tcrawley@gmail.com}
   s.extra_rdoc_files = [

data/spec/open_exception_spec.rb

@@ -1,37 +1,45 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'tempfile'
 
 describe "OpenException" do
   describe "parsing an exception" do
     it "should extract the file and line number" do
-      opener(stub_exception).send(:extract_file_and_line).should == ['/some/file.rb',
-                                                                     '1']
+      @opener = opener(stub_exception)
+      @opener.send(:extract_file_and_line)
+      @opener.send(:file_name).should == '/some/file.rb'
+      @opener.send(:line_number).should == '1'
     end
 
     it "should filter with a regex" do
       @opener = opener(stub_exception,
                        :backtrace_line_filters => [/other_file/])
-      @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
+      @opener.send(:extract_file_and_line)
+      @opener.send(:file_name).should == "/some/other_file.rb"
+      @opener.send(:line_number).should == '22'
     end
 
     it "should filter with a lambda" do
       @opener = opener(stub_exception,
                        :backtrace_line_filters => [lambda { |line| line =~ /other_file/ }])
-      @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
+      @opener.send(:extract_file_and_line)
+      @opener.send(:file_name).should == "/some/other_file.rb"
+      @opener.send(:line_number).should == '22'
     end
 
     it "should filter with an array of filters" do
       @opener = opener(stub_exception,
                        :backtrace_line_filters => [/not gonna match/,
-                                                  /other_file/])
-      @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
+                                                   /other_file/])
+      @opener.send(:extract_file_and_line)
+      @opener.send(:file_name).should == "/some/other_file.rb"
+      @opener.send(:line_number).should == '22'
     end
   end
 
   describe "opening an exception" do
-    it "should pass the exception args to open_file" do
+    it "should try to open the file" do
       @opener = opener(stub_exception)
-      @opener.should_receive(:open_file).with('/some/file.rb',
-                                              '1')
+      @opener.should_receive(:open_file)
       @opener.open
     end
 
@@ -72,12 +80,29 @@ describe "OpenException" do
       it "should not try to open a file that does not exist" do
         @opener = opener(nil)
         @opener.should_not_receive(:system)
-        @opener.send(:open_file, '/a/nonexistent/file', '0')
+        @opener.file_name = '/a/nonexistent/file'
+        @opener.send(:open_file)
+      end
+
+      it "should write out the trace to a file if the open_command contains {tracefile}" do
+        File.stub!(:readable?).and_return(true)
+        @opener = opener(stub_exception)
+        @opener.stub!(:open_command).and_return('{tracefile}')
+        Tempfile.should_receive(:open)
+        @opener.file_name = '/a/file'
+        @opener.line_number = '2'
+        @opener.stub!(:system)
+        @opener.send(:open_file)
+        
       end
     end
   end
 end
 
+class OpenException::ExceptionOpener
+  attr_writer :file_name, :line_number
+end
+
 def opener(ex, options = { })
   OpenException::ExceptionOpener.new(ex, options)
 end

data/spec/spec_helper.rb

@@ -12,6 +12,7 @@ end
 
 def stub_exception
   ex = mock('exception')
+  ex.stub!(:message).and_return("The message")
   ex.stub!(:backtrace).and_return([
                                    "/some/file.rb:1:in 'level_one'",
                                    "/some/other_file.rb:22:in 'level_two'",

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
   - 3
-  version: 0.2.3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Tobias Crawley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-29 00:00:00 -04:00
+date: 2010-05-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency