open_exception 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tobias Crawley
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= 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/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "open_exception"
+    gem.summary = %Q{Open an exception in your favorite editor}
+    gem.description = %Q{}
+    gem.email = "tcrawley@gmail.com"
+    gem.homepage = "http://github.com/tobias/open_exception"
+    gem.authors = ["Tobias Crawley"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "open_exception #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/init.rb

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

data/lib/open_exception/growl_support.rb

@@ -0,0 +1,25 @@
+module OpenException
+  module GrowlSupport
+    protected
+    def open_file(file, line)
+      growl_notify(file_line) if File.readable?(file)
+      super
+    end
+    
+    def growl_notify(file, line)
+      if Growl.installed?
+        Growl.notify do |n|
+          n.title = 'Open Exception'
+          n.message = growl_message(file, line)
+        end
+      end
+    end
+    
+    def growl_message(file, line)
+      msg = "Opening #{file}:#{line}"
+      msg << " in #{options[:open_with]}" if options[:open_with].is_a?(Symbol)
+    end
+  end
+end
+
+OpenException::ExceptionOpener.send(:include, OpenException::GrowlSupport)

data/lib/open_exception/open_exception.rb

@@ -0,0 +1,104 @@
+module OpenException
+  
+  class << self
+    attr_writer :options
+    
+    def options
+      @options ||= { }
+    end
+
+    def open(exception, options = { })
+      ExceptionOpener.new(exception, options).open
+    end
+  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)
+    end
+
+    def open
+      if !exclude_exception?
+        file_and_line = extract_file_and_line
+        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*)/
+        [$1, $2]
+      end
+    end
+
+    def filter_backtrace(backtrace)
+      if options[:backtrace_line_filter]
+        backtrace.find do |line|
+          apply_backtrace_filter(options[:backtrace_line_filter], line)
+        end
+      else
+        backtrace.first
+      end
+    end
+
+    def apply_backtrace_filter(filter, line)
+      if filter.respond_to?(:each)
+        filter.any? { |f| apply_backtrace_filter(f, line) }
+      elsif filter.respond_to?(:call)
+        filter.call(line)
+      else
+        line =~ filter
+      end
+    end
+    
+    def exclude_exception?
+      if options[:exclusion_filter]
+        apply_exclusion_filter(options[:exclusion_filter])
+      end
+    end
+
+    def apply_exclusion_filter(filter)
+      if filter.respond_to?(:each)
+        filter.any? { |f| apply_exclusion_filter(f) }
+      elsif filter.respond_to?(:call)
+        filter.call(exception)
+      else
+        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)
+        puts cmd
+        system(cmd)
+      end
+    end
+
+    def open_command
+      if options[:open_with].is_a?(Symbol)
+        options[:"#{options[:open_with]}_command"]
+      else
+        options[:open_with]
+      end
+    end
+  end
+
+end

data/lib/open_exception/rails.rb

@@ -0,0 +1,22 @@
+module OpenException
+  module ActionControllerExtensions
+    def self.included(base)
+      base.send(:alias_method,
+                :rescue_action_locally_without_open_exception,
+                :rescue_action_locally)
+      base.send(:alias_method,
+                :rescue_action_locally,
+                :rescue_action_locally_with_open_exception)
+    end
+    
+    def rescue_action_locally_with_open_exception(exception)
+      OpenException.open(exception)
+      rescue_action_locally_without_open_exception(exception)
+    end
+  end
+end
+
+if !ActionController::Base.ancestors.include?(OpenException::ActionControllerExtensions)
+  ActionController::Base.send(:include, OpenException::ActionControllerExtensions)
+  OpenException.options[:backtrace_line_filter] = %r{#{Rails.root}/(app|lib)}
+end

data/lib/open_exception.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + "/open_exception/open_exception"
+require File.dirname(__FILE__) + "/open_exception/rails" if defined?(ActionController)
+
+begin
+  require 'growl'
+  require File.dirname(__FILE__) + "/open_exception/growl_support"
+rescue LoadError
+  #ignore
+end

data/open_exception.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{open_exception}
+  s.version = "0.2.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-23}
+  s.description = %q{}
+  s.email = %q{tcrawley@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  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"
+  ]
+  s.homepage = %q{http://github.com/tobias/open_exception}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Open an exception in your favorite editor}
+  s.test_files = [
+    "spec/open_exception_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/rails/init.rb

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

data/spec/open_exception_spec.rb

@@ -0,0 +1,85 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+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']
+    end
+
+    it "should filter with a regex" do
+      @opener = opener(stub_exception,
+                       :backtrace_line_filter => /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/ })
+      @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/,
+                                                  /other_file/])
+      @opener.send(:extract_file_and_line).should == ["/some/other_file.rb", '22']
+    end
+  end
+
+  describe "opening an exception" do
+    it "should pass the exception args to open_file" do
+      @opener = opener(stub_exception)
+      @opener.should_receive(:open_file).with('/some/file.rb',
+                                              '1')
+      @opener.open
+    end
+
+    it "should not try to open if no backtrace exists" do
+      @opener = opener(Exception.new)
+      @opener.should_not_receive(:open_file)
+      @opener.open
+    end
+    
+    describe "excluding exceptions" do
+      it "should not try to open the exception if it should be excluded" do
+        @opener = opener(Exception.new)
+        @opener.should_receive(:exclude_exception?).and_return(true)
+        @opener.should_not_receive(:extract_file_and_line)
+        @opener.open
+      end
+
+      it "should exclude based on exception class" do
+        @opener = opener(Exception.new, :exclusion_filter => 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.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.should_not_receive(:extract_file_and_line)
+        @opener.open
+      end
+    end
+    
+    describe "open_file" 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')
+      end
+    end
+  end
+end
+
+def opener(ex, options = { })
+  OpenException::ExceptionOpener.new(ex, options)
+end
+
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'open_exception'
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+require 'ap'
+
+Spec::Runner.configure do |config|
+  
+end
+
+def stub_exception
+  ex = mock('exception')
+  ex.stub!(:backtrace).and_return([
+                                   "/some/file.rb:1:in 'level_one'",
+                                   "/some/other_file.rb:22:in 'level_two'",
+                                   "/some/a_third_file.rb:333:in 'level_three'"
+                                  ])
+  ex
+end
+

data/test_data/raiser.rb

@@ -0,0 +1,25 @@
+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

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: open_exception
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tobias Crawley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-23 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: ""
+email: tcrawley@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+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
+has_rdoc: true
+homepage: http://github.com/tobias/open_exception
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Open an exception in your favorite editor
+test_files: 
+- spec/open_exception_spec.rb
+- spec/spec_helper.rb