Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Ruby gem for extended backtraces with parameter values
C Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

RubyExtBacktrace

Provides extended backtrace for ruby, including method parameters values.

Installation

Add this line to your application's Gemfile:

gem 'ruby_ext_backtrace'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ruby_ext_backtrace

Usage

Once loaded, gem provides global method caller_ext, similar to Kernel#caller, but returning an array of hashes.

require 'pp'
require 'ruby_ext_backtrace'

def some_method2 param
  c1 = caller_ext(0); c2 = caller(0)
  pp c1
  puts "\n#Original caller for comparison:"
  pp c2
end

def some_method param1, param2=nil, *splat, &blk
  yield "block_param0", "block_param1"
end

some_method(1111, nil, 1, 2, 3){|bp1,bp2|
  some_method2 "some_method2_param"
}

this outputs:

[{:file=>"test.rb",
  :line=>10,
  :method=>"some_method2",
  :argc=>1,
  0=>"some_method2_param"},
 {:file=>"test.rb",
  :line=>21,
  :method=>"block in <main>",
  :argc=>2,
  0=>"block_param0",
  1=>"block_param1"},
 {:file=>"test.rb",
  :line=>17,
  :method=>"some_method",
  :argc=>4,
  0=>1111,
  1=>nil,
  2=>[1, 2, 3],
  3=>#<Proc:0x007fc87c053290@test.rb:20>},
 {:file=>"test.rb", :line=>20, :method=>"<main>", :argc=>0}]

#Original caller for comparison:
["test.rb:10:in `some_method2'",
 "test.rb:21:in `block in <main>'",
 "test.rb:17:in `some_method'",
 "test.rb:20:in `<main>'"]

Note that fetching parameters for CFUNCs with variable parameters (argc<0) is not supported. Also instead of "<ruby>" :file can be nil, so does :method for unknown methods.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.