debug_inspector

Adds methods to RubyVM::DebugInspector to allow for inspection of backtrace frames. The debug_inspector C extension and API were designed and built by Koichi Sasada, this project is just a gemification of his work. This library makes use of the debug inspector API which was added to MRI 2.0.0. Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op. Recommended for use only in debugging situations. Do not use this in production apps.


License
MIT
Install
gem install debug_inspector -v 1.1.0

Documentation

Build Status Gem Version

debug_inspector

A Ruby wrapper for the MRI 2.0+ debug_inspector API

The debug_inspector C extension and API were designed and built by Koichi Sasada, this project is just a gemification of his work.

NOTES:

  • Do not use this library outside of debugging situations.
  • This library makes use of the debug inspector API which was new in MRI 2.0.0.
  • Only works on MRI 2 and 3. Requiring it on unsupported Rubies will result in a no-op

Usage

require 'debug_inspector'

# Open debug context
# Passed `dc' is only active in a block
RubyVM::DebugInspector.open { |dc|
  # backtrace locations (returns an array of Thread::Backtrace::Location objects)
  locs = dc.backtrace_locations

  # you can get depth of stack frame with `locs.size'
  locs.size.times do |i|
    # binding of i-th caller frame (returns a Binding object or nil)
    p dc.frame_binding(i)

    # iseq of i-th caller frame (returns a RubyVM::InstructionSequence object or nil)
    p dc.frame_iseq(i)

    # class of i-th caller frame
    p dc.frame_class(i)
  end
}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contact

Problems or questions contact me at github

License

(The MIT License)

Copyright (c) 2012-2013 (John Mair)

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.