SuperCaller 1.0.0

data/History.txt

@@ -0,0 +1,5 @@
+== 1.0.0 / 2007-06-30
+
+* 1 major enhancement
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/super_caller.rb
+lib/super_caller/exception.rb

data/README.txt

@@ -0,0 +1,55 @@
+= SuperCaller
+
+A Kernel#caller enhancement
+
+Documentation:
+
+http://seattlerb.org/SuperCaller
+
+File Bugs:
+
+http://rubyforge.org/tracker/?func=add&group_id=1513&atid=5921
+
+== DESCRIPTION:
+
+SuperCaller adds a beefed-up version of Kernel#caller and a beefed up
+version of Exception#backtrace.
+
+== FEATURES/PROBLEMS:
+
+* Can cause Ruby to crash when an Exception with SuperCaller's
+  backtrace reaches the top level.
+
+== SYNOPSIS:
+
+Regular old Kernel#super_caller:
+
+  require 'super_caller'
+  
+  def something() super_caller end
+  stack = something
+  p stack.first.file # => "-"
+  p stack.first.line # => 4
+  p stack.first.method_name # => nil
+  p stack.first.self # => main
+  p stack.first.sexp # => [:vcall, :super_caller]
+  p stack.first.source # => "def something\n  super_caller\nend"
+
+Fancy Exception#backtrace:
+
+  require 'super_caller/exception'
+  
+  def raiser() raise end
+  
+  def raisee
+    raiser
+  rescue => e
+    p e.backtrace.first.sexp
+  end
+  
+  raiser # => [:vcall, :raise]
+
+== INSTALL:
+
+  sudo gem install SuperCaller
+

data/Rakefile

@@ -0,0 +1,20 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/super_caller.rb'
+
+Hoe.new('SuperCaller', SuperCaller::VERSION) do |p|
+  p.rubyforge_name = 'seattlerb'
+  p.author = 'Eric Hodel'
+  p.email = 'drbrain@segment7.net'
+  p.summary = p.paragraphs_of('README.txt', 1).first
+  p.description = p.paragraphs_of('README.txt', 7).first
+  p.url = p.paragraphs_of('README.txt', 3).first
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+
+  p.extra_deps << ['ParseTree', '~> 2.0']
+  p.extra_deps << ['ruby2ruby', '~> 1.1']
+end
+
+# vim: syntax=Ruby

data/lib/super_caller.rb

@@ -0,0 +1,113 @@
+require 'rubygems'
+require 'inline'
+require 'parse_tree'
+require 'ruby2ruby'
+
+module SuperCaller
+
+  VERSION = '1.0.0'
+
+  Frame = Struct.new :file, :line, :method_name, :self, :sexp
+
+  class Frame
+    def to_s
+      if method_name then
+        "%s:%d:in `%s'" % [file, line, method_name]
+      else
+        "%s:%d" % [file, line]
+      end
+    end
+
+    alias to_str to_s
+
+    def split(*args)
+      to_s.split(*args)
+    end
+
+    def source
+      return unless method_name
+      sexp = Sexp.for self.self.class, method_name, true
+      return if s(nil) == sexp
+      RubyToRuby.new.process sexp rescue nil
+    end
+  end
+
+  inline :C do |builder|
+    builder.include '"ruby.h"'
+    builder.include '"node.h"'
+    builder.include '"env.h"'
+
+    builder.prefix <<-'EOF'
+    static VALUE rb_mSuperCaller = Qnil;
+    static VALUE rb_cSuperCaller_Frame = Qnil;
+
+    void add_to_parse_tree(VALUE ary,
+                           NODE * n,
+                           VALUE newlines,
+                           ID * locals);
+
+    static VALUE node_to_sexp(NODE * node) {
+      VALUE sexp = rb_ary_new();
+
+      add_to_parse_tree(sexp, node, Qfalse, NULL);
+
+      if (RARRAY(sexp)->len == 0) {
+        return Qnil;
+      } else {
+        return RARRAY(sexp)->ptr[0];
+      }
+    }
+    EOF
+
+    builder.c <<-'EOF'
+    static VALUE
+    super_caller() {
+      struct FRAME * c_frame = ruby_frame;
+      VALUE r_frame, stack, method_name;
+      NODE * n;
+
+      if (NIL_P(rb_cSuperCaller_Frame)) {
+        rb_mSuperCaller =
+          rb_const_get(rb_cObject, rb_intern("SuperCaller"));
+        rb_cSuperCaller_Frame =
+          rb_const_get(rb_mSuperCaller, rb_intern("Frame"));
+      }
+
+      stack = rb_ary_new();
+
+      if (c_frame->last_func == ID_ALLOCATOR)
+        c_frame = c_frame->prev;
+
+      for (; c_frame && (n = c_frame->node); c_frame = c_frame->prev) {
+        if (c_frame->prev && c_frame->prev->last_func) {
+          if (c_frame->prev->node == n) {
+            if (c_frame->prev->last_func == c_frame->last_func)
+              continue;
+          }
+
+          method_name = ID2SYM(c_frame->prev->last_func);
+        } else {
+          method_name = Qnil;
+        }
+
+        r_frame = rb_funcall(rb_cSuperCaller_Frame, rb_intern("new"), 5,
+                             rb_str_new2(n->nd_file),
+                             INT2FIX(nd_line(n)),
+                             method_name,
+                             c_frame->self,
+                             node_to_sexp(n));
+
+        rb_ary_push(stack, r_frame);
+      }
+
+      return stack;
+    }
+    EOF
+  end
+
+end
+
+class Object
+  include SuperCaller
+end
+

data/lib/super_caller/exception.rb

@@ -0,0 +1,31 @@
+require 'super_caller'
+
+module Kernel
+
+  alias old_raise raise
+
+  def raise(*args)
+    old_raise(*args)
+  rescue Exception => e
+    e.backtrace = super_caller[1..-1]
+    old_raise e
+  end
+
+end
+
+class Exception
+
+  alias old_backtrace backtrace
+
+  attr_reader :backtrace
+
+  alias old_set_backtrace set_backtrace
+
+  def backtrace=(backtrace)
+    old_set_backtrace backtrace.map { |frame| frame.to_s }
+    @backtrace = backtrace
+  end
+
+  alias set_backtrace backtrace=
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4.3
+specification_version: 1
+name: SuperCaller
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-08-04 00:00:00 -07:00
+summary: A Kernel#caller enhancement
+require_paths: 
+- lib
+email: drbrain@segment7.net
+homepage: http://seattlerb.org/SuperCaller
+rubyforge_project: seattlerb
+description: SuperCaller adds a beefed-up version of Kernel#caller and a beefed up version of Exception#backtrace.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Eric Hodel
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/super_caller.rb
+- lib/super_caller/exception.rb
+test_files: []
+
+rdoc_options: 
+- --main
+- README.txt
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ParseTree
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: ruby2ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.2
+    version: