/tracerius

Nice, lightweight and flexible line by line tracer for Ruby.

Primary LanguageRubyMIT LicenseMIT

Tracerius

Build Status

Tracerius is a simple tracer for your Ruby code. It follows your codebase line by line and deep dive into any gem source to carefully inspect every method you call. Think - it's "puts debugging" on steroids.

It's very opinioned out of the box and has only few options to tweak, which makes it extremly simple to use - just plug and play! Think - it's Rails among tracers.

Installation

Add this line to your application's Gemfile:

gem 'tracerius'

And then execute:

$ bundle

Or install it yourself as:

$ gem install tracerius

Usage

Configuration

Tracerius provides a few options you can configure:

  • Show or not params for methods (for custom classes you can choose a strategie)
  • Write output on screen or to file (also you can provide your custom strategie)
  • How to handle fatal errors (few options)

You can skip setting it up, because Tracerius provides saine defaults for every case.

Basic usage might look like:

Tracerius::Runner.run do
  puts "Hello"
end
Output:
47.929 0.000     line hello.rb:4
47.929 0.000   c-call hello.rb:4        puts   Kernel
47.929 0.000   c-call hello.rb:4        puts       IO
47.930 0.000   c-call hello.rb:4       write       IO
47.930 0.001 c-return hello.rb:4       write       IO
47.930 0.000   c-call hello.rb:4       write       IO

47.930 0.000 c-return hello.rb:4       write       IO
47.930 0.000 c-return hello.rb:4        puts       IO
47.930 0.000 c-return hello.rb:4        puts   Kernel

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/raventid/tracerius.