stackdeck 0.1.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 Matthew Draper
+
+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 @@
+= stackdeck
+
+Manages stack traces across language boundaries.
+
+== 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 Matthew Draper. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "stackdeck"
+    gem.summary = %Q{Manages stack traces across language boundaries}
+    gem.description = %Q{Manages stack traces across language boundaries.}
+    gem.email = "matthew@trebex.net"
+    gem.homepage = "http://github.com/matthewd/stackdeck"
+    gem.authors = ["Matthew Draper"]
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "stackdeck #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/stackdeck.rb

@@ -0,0 +1,8 @@
+
+module StackDeck
+end
+
+require 'stackdeck/context'
+require 'stackdeck/frame'
+require 'stackdeck/exception'
+

data/lib/stackdeck/context.rb

@@ -0,0 +1,32 @@
+
+module StackDeck
+  class Context
+    CONTEXT = 7
+    attr_reader :before_lineno, :before, :line, :after
+    def context_ranges(lines, index)
+      first_line = [index - CONTEXT, 0].max
+      last_line = [index + CONTEXT, lines.size].min
+
+      [first_line...index, (index + 1)..last_line]
+    end
+    def initialize(lines, lineno)
+      if lineno
+        index = lineno - 1
+        pre_range, post_range = context_ranges(lines, index)
+        @before_lineno = pre_range.begin
+        @before = lines[pre_range]
+        @line = lines[index].chomp
+        @after = lines[post_range]
+      else
+        @line = lines.join("\n")
+      end
+    end
+
+    class File < Context
+      def initialize(filename, lineno)
+        super File.readlines(filename), lineno
+      end
+    end
+  end
+end
+

data/lib/stackdeck/exception.rb

@@ -0,0 +1,25 @@
+
+module StackDeck
+  module ExceptionSupport
+    def higher_stack_deck; @higher_stack_deck ||= []; end
+    def stack_deck
+      deck = []
+      deck.concat(internal_stack_deck || []) if respond_to? :internal_stack_deck
+      deck.concat higher_stack_deck
+      deck.concat StackDeck::Frame::Ruby.extract(backtrace) if backtrace
+      deck.compact!
+      StackDeck.apply_boundary!(deck)
+      deck
+    end
+    def copy_ruby_stack_to_deck(ignored_part=caller)
+      upper_backtrace, lower_backtrace = StackDeck.split_list(backtrace, ignored_part)
+      higher_stack_deck.concat StackDeck::Frame::Ruby.extract(upper_backtrace)
+      set_backtrace lower_backtrace
+    end
+  end
+end
+
+class Exception
+  include StackDeck::ExceptionSupport
+end
+

data/lib/stackdeck/frame.rb

@@ -0,0 +1,101 @@
+
+module StackDeck
+  def self.boundary; yield; end
+
+  def self.split_list(full_list, short_list)
+    short_list = short_list.dup
+    upper = full_list.dup
+    lower = []
+    while !short_list.empty? && upper.last == short_list.pop
+      lower << upper.pop
+    end
+    [upper, lower.reverse]
+  end
+
+  def self.apply_boundary!(deck)
+    deck.each_with_index do |s, idx|
+      # We don't want any more frames if this is a boundary marker,
+      # *and* the exception didn't occur really close to said boundary.
+      if s.boundary? && idx > 2
+        deck.slice! idx, -1
+        break
+      end
+    end
+  end
+
+  class Frame
+    attr_accessor :function, :filename, :lineno, :clue
+    def initialize(function, filename, lineno, clue=nil)
+      @function = function
+      @filename = filename unless filename && filename.empty?
+      @lineno = lineno
+      @clue = clue unless clue && clue.empty?
+    end
+    def context
+      @context ||= Context::File.new(filename, lineno) if filename
+    end
+    def same_line?(other)
+      other && self.filename == other.filename && self.lineno == other.lineno
+    end
+    def language; self.class.name.split('::').last; end
+    def boundary?; false; end
+
+    def to_s
+      "#{filename}:#{lineno}: in `#{function}' [#{language}]"
+    end
+
+    class Ruby < Frame
+      def self.parse(str)
+        if str =~ /(.*?):(\d+)(:in `(.*)')?/
+          new($4, $1, $2.to_i)
+        end
+      end
+      def self.extract(backtrace)
+        backtrace.map {|s| StackDeck::Frame::Ruby.parse(s) }
+      end
+
+      def boundary?
+        filename == __FILE__ && function == 'boundary'
+      end
+      def to_s
+        "#{filename}:#{lineno}: in `#{function}'"
+      end
+    end
+
+    class JavaScript < Frame
+      def self.parse(str)
+        if str =~ /^(.*)@(.*?):(\d+|\?)$/
+          function = $1
+          filename = $2
+          lineno = $3.to_i
+
+          return if filename == '' && function =~ /^(apply|call)\(/
+          return if filename == '' && function == '' && lineno == 0
+          return if function =~ /^__hidden(_[A-Za-z0-9_]*)?\(/
+          filename = filename.squeeze('/')
+
+          function.sub!(/\(.*/, '')
+
+          new(function, filename, lineno)
+        end
+      end
+    end
+
+    class SQL < Frame
+      def self.from_char(query, position)
+        before = query[0, position.to_i]
+        lineno = 1 + before.size - before.gsub(/\n/, '').size
+        self.new(query, lineno)
+      end
+
+      def initialize(query, lineno=nil, clue=nil)
+        @query = query
+        super(nil, nil, lineno, clue)
+      end
+      def context
+        @context ||= Context.new(@query.split(/\n/), lineno) if @query
+      end
+    end
+  end
+end
+

data/lib/stackdeck/postgres.rb

@@ -0,0 +1,68 @@
+
+require 'stackdeck'
+
+module StackDeck
+  class Context
+    class PgProc < Context
+      def initialize(conn, function, lineno)
+        # This will obviously fail on an overloaded function, returning
+        # the source of one arbitrarily-chosen variant.
+        src = conn.query('SELECT prosrc FROM pg_proc WHERE proname = ? ORDER BY pronargs DESC LIMIT 1', function)
+        src = src.first until String === src
+
+        lines = src.split(/\r?\n/)
+
+        # Apparently, if the first line of the function is empty (doesn't
+        # even contain any whitespace), PG doesn't count it when numbering
+        # lines. So we join in, by pretending it isn't there.
+        lines.shift if lines.first.empty?
+
+        super lines, lineno
+      end
+    end
+  end
+
+  class Frame
+    module Postgres
+      class Function < Frame
+        def initialize(conn, language, function, lineno, clue=nil)
+          @db_connection = conn
+          @language = language
+          super(function, nil, lineno, clue)
+        end
+        def context
+          @context ||= Context::PgProc.new(@db_connection, function, lineno) if @db_connection
+        end
+        def language
+          @language.gsub(/ function$/, '')
+        end
+      end
+
+      def self.extract(ex)
+        postgres_stack = []
+        if ex.internal_query
+          postgres_stack << Frame::SQL.from_char(ex.internal_query, ex.internal_position)
+        end
+        if ex.context
+          postgres_stack.concat ex.context.split(/\n/).map {|s| parse(s) }
+        end
+        if ex.query
+          postgres_stack << Frame::SQL.from_char(ex.query, ex.query_position)
+        end
+      end
+
+      def self.parse(str, conn=nil)
+        if str =~ /([^"]+) "(.*)"(?: line (\d+))?(?: (at [^"]+))?$/
+          case $1
+          when 'SQL statement'
+            Frame::SQL.new($2)
+          else
+            f = $1.empty? ? nil : $1
+            self::Function.new(conn, f, $2, $3.to_i, $4)
+          end
+        end
+      end
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'stackdeck'
+
+class Test::Unit::TestCase
+end

data/test/test_stackdeck.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestStackdeck < Test::Unit::TestCase
+  def test_something_for_real
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: stackdeck
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Draper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-10 00:00:00 +10:30
+default_executable: 
+dependencies: []
+
+description: Manages stack traces across language boundaries.
+email: matthew@trebex.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/stackdeck.rb
+- lib/stackdeck/context.rb
+- lib/stackdeck/exception.rb
+- lib/stackdeck/file_reader.rb
+- lib/stackdeck/frame.rb
+- lib/stackdeck/postgres.rb
+- test/helper.rb
+- test/test_stackdeck.rb
+has_rdoc: true
+homepage: http://github.com/matthewd/stackdeck
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Manages stack traces across language boundaries
+test_files: 
+- test/helper.rb
+- test/test_stackdeck.rb