open_exception 0.2.0 → 0.2.1

data/README.md

@@ -0,0 +1,44 @@
+open_exception
+==============
+
+open_exception opens an exception in your favorite editor when developing locally. It
+works by parsing the backtrace, and opening the offending file at the offending line 
+in your favorite editor (assuming your favorite editor supports remote open commands).
+
+You can add filters that allow you to ignore some exceptions, and filters that allow you 
+to scope the backtrace search. The backtrace scoping is useful for opening the last call
+in your application code when the exception occurs in a framework or lib.
+
+If you are on MacOSX and have the [growl gem](http://rubygems.org/gems/growl) installed,
+you will get a growl notification with the exception message when the file is opened.
+
+Configuration
+-------------
+
+To configure, pass a block to the configure method:
+    
+    OpenException.configure do |oe|
+      oe.open_with = :emacs
+    end
+
+Rails Integration
+-----------------
+
+auto filter
+
+Standalone/Other Frameworks
+---------------------------
+
+
+Note on Patches/Pull Requests
+-----------------------------
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Tobias Crawley. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/open_exception.rb

@@ -1,9 +1,14 @@
 require File.dirname(__FILE__) + "/open_exception/open_exception"
 require File.dirname(__FILE__) + "/open_exception/rails" if defined?(ActionController)
 
+init_message = "** open_extension initialized "
+
 begin
   require 'growl'
   require File.dirname(__FILE__) + "/open_exception/growl_support"
+  init_message << "with growl support"
 rescue LoadError
   #ignore
 end
+
+puts init_message

data/lib/open_exception/growl_support.rb

@@ -1,9 +1,17 @@
 module OpenException
   module GrowlSupport
+    def self.included(base)
+      if !base.instance_methods.include?(:open_without_growl)
+        base.send(:alias_method, :open_file_without_growl, :open_file)
+        base.send(:alias_method, :open_file, :open_file_with_growl)
+      end
+    end
+    
     protected
-    def open_file(file, line)
-      growl_notify(file_line) if File.readable?(file)
-      super
+    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)
     end
     
     def growl_notify(file, line)
@@ -16,10 +24,10 @@ module OpenException
     end
     
     def growl_message(file, line)
-      msg = "Opening #{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)
     end
   end
 end
 
-OpenException::ExceptionOpener.send(:include, OpenException::GrowlSupport)
+OpenException::ExceptionOpener.send(:include, OpenException::GrowlSupport) 

data/lib/open_exception/open_exception.rb

@@ -1,10 +1,24 @@
 module OpenException
+
+  EDITOR_COMMANDS = {
+    :emacs => '/usr/bin/emacsclient -n +{line} {file}',
+    :textmate => '/usr/local/bin/mate -a -d -l {line} {file}',
+    :macvim => '/usr/local/bin/mvim +{line} {file}'
+  }
   
+  DEFAULT_OPTIONS = {
+    :open_with => :emacs,
+    :exclusion_filters => [], #[ExceptionClass, lambda] # any can return/be true to exclude
+    :backtrace_line_filters => [] #[/regex/, lambda] # the first backtrace line that returns true is used
+  }
+
   class << self
-    attr_writer :options
-    
     def options
-      @options ||= { }
+      @options ||= DEFAULT_OPTIONS.clone
+    end
+
+    def configure
+      yield Configurator.new(options)
     end
 
     def open(exception, options = { })
@@ -13,22 +27,12 @@ module OpenException
   end
 
   class ExceptionOpener
-    DEFAULT_OPTIONS = {
-      :open_with => :emacs,
-      :emacs_command => '/usr/bin/emacsclient -n +{line} {file}',
-      :textmate_command => '/usr/local/bin/mate -a -d -l {line} {file}',
-      :macvim_command => '/usr/local/bin/mvim +{line} {file}'
-      # :exclusion_filter => [ExceptionClass, lambda] # any can return/be
-      # true to exclude
-      # :backtrace_line_filter => [/regex/, lambda] # the first backtrace
-      # line that returns true is used
-    }
 
     attr_accessor :options
 
     def initialize(exception, options = {})
       @exception = exception
-      @options = DEFAULT_OPTIONS.merge(OpenException.options).merge(options)
+      @options = OpenException.options.merge(options)
     end
 
     def open
@@ -37,21 +41,21 @@ module OpenException
         open_file(*file_and_line) if file_and_line
       end
     end
-    
+
     protected
     attr_reader :exception
-    
+
     def extract_file_and_line
       if exception.backtrace and
-        filter_backtrace(exception.backtrace) =~ /(.*?):(\d*)/
+          filter_backtrace(exception.backtrace) =~ /(.*?):(\d*)/
         [$1, $2]
       end
     end
 
     def filter_backtrace(backtrace)
-      if options[:backtrace_line_filter]
+      if !options[:backtrace_line_filters].empty?
         backtrace.find do |line|
-          apply_backtrace_filter(options[:backtrace_line_filter], line)
+          apply_backtrace_filter(options[:backtrace_line_filters], line)
         end
       else
         backtrace.first
@@ -67,10 +71,10 @@ module OpenException
         line =~ filter
       end
     end
-    
+
     def exclude_exception?
-      if options[:exclusion_filter]
-        apply_exclusion_filter(options[:exclusion_filter])
+      if !options[:exclusion_filters].empty?
+        apply_exclusion_filter(options[:exclusion_filters])
       end
     end
 
@@ -83,7 +87,7 @@ module OpenException
         exception.is_a?(filter)
       end
     end
-    
+
     def open_file(file_name, line_number)
       if File.readable?(file_name)
         cmd = open_command.gsub('{file}', file_name).gsub('{line}', line_number)
@@ -94,11 +98,24 @@ module OpenException
 
     def open_command
       if options[:open_with].is_a?(Symbol)
-        options[:"#{options[:open_with]}_command"]
+        EDITOR_COMMANDS[options[:open_with]]  
       else
         options[:open_with]
       end
     end
   end
+  
+  class Configurator
+    def initialize(options)
+      @options = options
+    end
 
+    def method_missing(method, arg = nil)
+      if method.to_s =~ /(.*?)=/
+        @options[$1.to_sym] = arg
+      else
+        @options[method]
+      end
+    end
+  end
 end

data/lib/open_exception/rails.rb

@@ -18,5 +18,5 @@ end
 
 if !ActionController::Base.ancestors.include?(OpenException::ActionControllerExtensions)
   ActionController::Base.send(:include, OpenException::ActionControllerExtensions)
-  OpenException.options[:backtrace_line_filter] = %r{#{Rails.root}/(app|lib)}
+  OpenException.options[:backtrace_line_filters] << %r{#{Rails.root}/(app|lib)}
 end

data/open_exception.gemspec

@@ -5,35 +5,31 @@
 
 Gem::Specification.new do |s|
   s.name = %q{open_exception}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias Crawley"]
-  s.date = %q{2010-04-23}
+  s.date = %q{2010-04-26}
   s.description = %q{}
   s.email = %q{tcrawley@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
      "Rakefile",
      "VERSION",
-     "init.rb",
      "lib/open_exception.rb",
      "lib/open_exception/growl_support.rb",
      "lib/open_exception/open_exception.rb",
      "lib/open_exception/rails.rb",
      "open_exception.gemspec",
-     "rails/init.rb",
      "spec/open_exception_spec.rb",
      "spec/spec.opts",
-     "spec/spec_helper.rb",
-     "test_data/raiser.rb"
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/tobias/open_exception}
   s.rdoc_options = ["--charset=UTF-8"]

data/spec/open_exception_spec.rb

@@ -9,19 +9,19 @@ describe "OpenException" do
 
     it "should filter with a regex" do
       @opener = opener(stub_exception,
-                       :backtrace_line_filter => /other_file/)
+                       :backtrace_line_filters => [/other_file/])
       @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
     end
 
     it "should filter with a lambda" do
       @opener = opener(stub_exception,
-                       :backtrace_line_filter => lambda { |line| line =~ /other_file/ })
+                       :backtrace_line_filters => [lambda { |line| line =~ /other_file/ }])
       @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
     end
 
     it "should filter with an array of filters" do
       @opener = opener(stub_exception,
-                       :backtrace_line_filter => [/not gonna match/,
+                       :backtrace_line_filters => [/not gonna match/,
                                                   /other_file/])
       @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
     end
@@ -50,19 +50,19 @@ describe "OpenException" do
       end
 
       it "should exclude based on exception class" do
-        @opener = opener(Exception.new, :exclusion_filter => Exception)
+        @opener = opener(Exception.new, :exclusion_filters => [Exception])
         @opener.should_not_receive(:extract_file_and_line)
         @opener.open
       end
 
       it "should exclude based on a lambda" do
-        @opener = opener(Exception.new, :exclusion_filter => lambda { |ex| true })
+        @opener = opener(Exception.new, :exclusion_filters => [lambda { |ex| true }])
         @opener.should_not_receive(:extract_file_and_line)
         @opener.open
       end
 
       it "should exclude based on an array of filters" do
-        @opener = opener(Exception.new, :exclusion_filter => [StandardError, Exception])
+        @opener = opener(Exception.new, :exclusion_filters => [StandardError, Exception])
         @opener.should_not_receive(:extract_file_and_line)
         @opener.open
       end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Tobias Crawley
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 -04:00
+date: 2010-04-26 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,25 +39,22 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
 - Rakefile
 - VERSION
-- init.rb
 - lib/open_exception.rb
 - lib/open_exception/growl_support.rb
 - lib/open_exception/open_exception.rb
 - lib/open_exception/rails.rb
 - open_exception.gemspec
-- rails/init.rb
 - spec/open_exception_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- test_data/raiser.rb
+- README.md
 has_rdoc: true
 homepage: http://github.com/tobias/open_exception
 licenses: []

data/README.rdoc

@@ -1,17 +0,0 @@
-= open_exception
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Tobias Crawley. See LICENSE for details.

data/init.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), "lib", "open_exception")

data/rails/init.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), "..", "init")

data/test_data/raiser.rb

@@ -1,25 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../lib/open_exception')
-
-class Raiser
-  def raise_now
-    raise Exception.new
-  end
-
-  def raise_first_level
-    raise_now
-  end
-
-  def raise_second_level
-    raise_first_level
-  end
-
-  def file
-    __FILE__
-  end
-  
-  def self.raise_and_open(options = {})
-    Raiser.new.raise_now
-  rescue Exception
-    OpenException.open($!, options)
-  end
-end