tracer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f82acd68b0e8d7cd3f4f8f76edf568b7eba1cb93617c2b61bb1c309cabb13d
-  data.tar.gz: 99975c258b07d9aa9a2b615ef5edc4284d57881300f2bc1d556cc0394e4ce471
+  metadata.gz: f040d7e0181c8be3aa0d41e5be786aca6d3632c1367b6180a3cfc2b19bda57bf
+  data.tar.gz: 43143d936ab079338c0039718c021f6c9d50d8ac93ba5a1a90320eeed466eaf1
 SHA512:
-  metadata.gz: 7446a1e834acf1139d4a8e2bbe5123c58abb2977f110bf7179128607886cae256cf830948de0b754d354360464ad4c9e70fd52b6e18d8a451b4030921cde65fa
-  data.tar.gz: 9b0cbe82ba37dce014210083b8110dfa9f59cd795bb2e1d5058a2fea432f8ba7aa0f0453a4d5f046c60416fea7ef4463862cfdd8acebae901bfa69809d25fc6a
+  metadata.gz: 51e73efd3fc7eea7b783f797f6afa67b1d7cee068383e36e076046a17462d1a7f36b58b85150bcbb700f0b7c24214b5893039241bfc16c27cc72f9fea4e6665b
+  data.tar.gz: 8cb8b671a2e630a0f03b1485f858320ccd7bcb260a06c41dbb373342774377c6911335d78e50f7f473b4722df24f070e8409c02c9ce3223455c001aaff08a8e8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at stan.lo@shopify.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,11 +1,13 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source "https://rubygems.org"
 
+# Specify your gem's dependencies in ruby-tracer.gemspec
 gemspec
 
-group :development do
-  gem "bundler"
-  gem "rake"
-  gem "test-unit"
-end
+gem "rake", "~> 13.0"
+gem "irb"
+
+gem "test-unit", "~> 3.0"
+
+gem "ruby-lsp"

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    tracer (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    language_server-protocol (3.17.0.3)
+    power_assert (2.0.2)
+    prettier_print (1.2.0)
+    rake (13.0.6)
+    reline (0.3.2)
+      io-console (~> 0.5)
+    ruby-lsp (0.3.8)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 5.0.0, < 6)
+    sorbet-runtime (0.5.10648)
+    syntax_tree (5.3.0)
+      prettier_print (>= 1.2.0)
+    test-unit (3.5.5)
+      power_assert
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  irb
+  rake (~> 13.0)
+  ruby-lsp
+  test-unit (~> 3.0)
+  tracer!
+
+BUNDLED WITH
+   2.4.2

data/README.md

@@ -1,84 +1,224 @@
 # Tracer
 
-Outputs a source level execution trace of a Ruby program.
-
-It does this by registering an event handler with Kernel#set_trace_func for processing incoming events.  It also provides methods for filtering unwanted trace output (see Tracer.add_filter, Tracer.on, and Tracer.off).
+Tracer is an extraction of [`ruby/debug`](https://github.com/ruby/debug)'s [powerful tracers](https://github.com/ruby/debug/blob/master/lib/debug/tracer.rb), with user-facing APIs, IRB-integration, and some improvements.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```shell
+$ bundle add tracer --group=development,test
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-```ruby
-gem 'tracer'
+```shell
+$ gem install tracer
 ```
 
-And then execute:
+## Usage
 
-    $ bundle
+```rb
+Tracer.trace(object) { ... } # trace object's activities in the given block
+Tracer.trace_call { ... } # trace method calls in the given block
+Tracer.trace_exception { ... } # trace exceptions in the given block
+```
 
-Or install it yourself as:
+**Example**
 
-    $ gem install tracer
+```rb
+require "tracer"
 
-## Usage
+obj = Object.new
+
+def obj.foo
+  100
+end
+
+def bar(obj)
+  obj.foo
+end
+
+Tracer.trace(obj) { bar(obj) }
+ #depth:1  #<Object:0x000000010903c190> is used as a parameter obj of Object#bar at test.rb:13:in `block in <main>'
+ #depth:2  #<Object:0x000000010903c190> receives .foo at test.rb:10:in `bar'
+```
+
+### `tracer/helper`
+
+If you want to avoid the `Tracer` namespace, you can do `require "tracer/helper"` instead:
 
-Consider the following Ruby script
+```rb
+require "tracer/helper"
 
+trace(object) { ... } # trace object's activities in the given block
+trace_call { ... } # trace method calls in the given block
+trace_exception { ... } # trace exceptions in the given block
 ```
-  class A
-    def square(a)
-      return a*a
-    end
-  end
-
-  a = A.new
-  a.square(5)
+
+### IRB-integration
+
+Once required, `tracer` registers a few IRB commands to help you trace Ruby expressions:
+
+```
+trace              Trace the target object (or self) in the given expression. Usage: `trace [target,] <expression>`
+trace_call         Trace method calls in the given expression. Usage: `trace_call <expression>`
+trace_exception    Trace exceptions in the given expression. Usage: `trace_exception <expression>`
+```
+
+**Example**
+
+```rb
+# test.rb
+require "tracer"
+
+obj = Object.new
+
+def obj.foo
+  100
+end
+
+def bar(obj)
+  obj.foo
+end
+
+binding.irb
 ```
 
-Running the above script using <code>ruby -r tracer example.rb</code> will output the following trace to STDOUT (Note you can also explicitly <code>require 'tracer'</code>)
 
 ```
-  #0:<internal:lib/rubygems/custom_require>:38:Kernel:<: -
-  #0:example.rb:3::-: class A
-  #0:example.rb:3::C: class A
-  #0:example.rb:4::-:   def square(a)
-  #0:example.rb:7::E: end
-  #0:example.rb:9::-: a = A.new
-  #0:example.rb:10::-: a.square(5)
-  #0:example.rb:4:A:>:   def square(a)
-  #0:example.rb:5:A:-:     return a*a
-  #0:example.rb:6:A:<:   end
-   |  |         | |  |
-   |  |         | |   ---------------------+ event
-   |  |         |  ------------------------+ class
-   |  |          --------------------------+ line
-   |   ------------------------------------+ filename
-    ---------------------------------------+ thread
+irb(main):001:0> trace obj, bar(obj)
+ #depth:23 #<Object:0x0000000107a86648> is used as a parameter obj of Object#bar at (eval):1:in `<main>'
+ #depth:24 #<Object:0x0000000107a86648> receives .foo at test.rb:10:in `bar'
+=> 100
+irb(main):002:0> trace_call bar(obj)
+ #depth:23>                            Object#bar at (eval):1:in `<main>'
+ #depth:24>                             #<Object:0x0000000107a86648>.foo at test.rb:10:in `bar'
+ #depth:24<                             #<Object:0x0000000107a86648>.foo #=> 100 at test.rb:10:in `bar'
+ #depth:23<                            Object#bar #=> 100 at (eval):1:in `<main>'
+=> 100
+```
+
+### Tracer Classes
+
+If you want to have more control over individual traces, you can use individual tracer classes:
+
+#### ObjectTracer
+
+```rb
+class User
+  def initialize(name) = (@name = name)
+
+  def name() = @name
+end
+
+def authorized?(user)
+  user.name == "John"
+end
+
+user = User.new("John")
+tracer = ObjectTracer.new(user)
+tracer.start do
+  user.name
+  authorized?(user)
+end
+
+ #depth:3  #<User:0x000000010696cad8 @name="John"> receives #name (User#name) at test.rb:14:in `block in <main>'
+ #depth:3  #<User:0x000000010696cad8 @name="John"> is used as a parameter user of Object#authorized? at test.rb:15:in `block in <main>'
+ #depth:4  #<User:0x000000010696cad8 @name="John"> receives #name (User#name) at test.rb:8:in `authorized?'
 ```
 
-Symbol table used for displaying incoming events:
+#### ExceptionTracer
+
+```rb
+ExceptionTracer.new.start
+
+begin
+  raise "boom"
+rescue StandardError
+  nil
+end
+
+ #depth:1  #<RuntimeError: boom> at test.rb:4
+```
 
+#### CallTracer
+
+```rb
+class User
+  def initialize(name) = (@name = name)
+
+  def name() = @name
+end
+
+def authorized?(user)
+  user.name == "John"
+end
+
+user = User.new("John")
+tracer = CallTracer.new
+tracer.start do
+  user.name
+  authorized?(user)
+end
+
+ #depth:4 >    block at test.rb:13
+ #depth:5 >     User#name at test.rb:4
+ #depth:5 <     User#name #=> "John" at test.rb:4
+ #depth:5 >     Object#authorized? at test.rb:7
+ #depth:6 >      User#name at test.rb:4
+ #depth:6 <      User#name #=> "John" at test.rb:4
+ #depth:6 >      String#== at test.rb:8
+ #depth:6 <      String#== #=> true at test.rb:8
+ #depth:5 <     Object#authorized? #=> true at test.rb:9
+ #depth:4 <    block #=> true at test.rb:16
 ```
-+}+:: call a C-language routine
-+{+:: return from a C-language routine
-+>+:: call a Ruby method
-+C+:: start a class or module definition
-+E+:: finish a class or module definition
-+-+:: execute code on a new line
-+^+:: raise an exception
-+<+:: return from a Ruby method
+
+#### LineTracer
+
+```rb
+class User
+  def initialize(name) = (@name = name)
+
+  def name() = @name
+end
+
+def authorized?(user)
+  user.name == "John"
+end
+
+user = User.new("John")
+tracer = LineTracer.new
+tracer.start do
+  user.name
+  authorized?(user)
+end
+
+ #depth:4  at test.rb:14
+ #depth:4  at test.rb:15
+ #depth:5  at test.rb:8
 ```
 
+## Customization
+
+TBD
+
+## Acknowledgement
+
+[@ko1](https://github.com/ko1) (Koichi Sasada) implemented the majority of [`ruby/debug`](https://github.com/ruby/debug), including its tracers. So this project wouldn't exist without his amazing work there.
+
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test-unit` 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](https://rubygems.org).
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/tracer.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/tracer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ruby/tracer/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).
+
+## Code of Conduct
+
+Everyone interacting in the Ruby::Tracer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ruby/tracer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test/lib"
-  t.ruby_opts << "-rhelper"
-  t.test_files = FileList["test/**/test_*.rb"]
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/lib/tracer/base.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require "pp"
+require_relative "color"
+
+module Tracer
+  class Base
+    DIR = __dir__
+    M_OBJECT_ID = Object.instance_method(:object_id)
+    M_INSPECT = Object.instance_method(:inspect)
+    M_CLASS = Object.instance_method(:class)
+    M_IS_A = Object.instance_method(:is_a?)
+    HOME = ENV["HOME"] ? (ENV["HOME"] + "/") : nil
+
+    include Color
+
+    class LimitedPP
+      def self.pp(obj, max)
+        out = self.new(max)
+        catch out do
+          PP.singleline_pp(obj, out)
+        end
+        out.buf
+      end
+
+      attr_reader :buf
+
+      def initialize(max)
+        @max = max
+        @cnt = 0
+        @buf = String.new
+      end
+
+      def <<(other)
+        @buf << other
+
+        if @buf.size >= @max
+          @buf = @buf[0..@max] + "..."
+          throw self
+        end
+      end
+    end
+
+    def safe_inspect(obj, max_length: 40)
+      LimitedPP.pp(obj, max_length)
+    rescue NoMethodError => e
+      klass, oid = M_CLASS.bind_call(obj), M_OBJECT_ID.bind_call(obj)
+      if obj == (r = e.receiver)
+        "#<#{klass.name}#{oid} does not have \#inspect>"
+      else
+        rklass, roid = M_CLASS.bind_call(r), M_OBJECT_ID.bind_call(r)
+        "#<#{klass.name}:#{roid} contains #<#{rklass}:#{roid} and it does not have #inspect>"
+      end
+    rescue Exception => e
+      "<#inspect raises #{e.inspect}>"
+    end
+
+    def pretty_path(path)
+      return "#<none>" unless path
+
+      case
+      when path.start_with?(dir = RbConfig::CONFIG["rubylibdir"] + "/")
+        path.sub(dir, "$(rubylibdir)/")
+      when Gem.path.any? { |gp| path.start_with?(dir = gp + "/gems/") }
+        path.sub(dir, "$(Gem)/")
+      when HOME && path.start_with?(HOME)
+        path.sub(HOME, "~/")
+      else
+        path
+      end
+    end
+
+    def initialize(output: STDOUT, pattern: nil, colorize: nil, depth_offset: 0)
+      @name = self.class.name
+      @type = @name.sub(/Tracer\z/, "")
+      @output = output
+      @depth_offset = depth_offset
+      @colorize = colorize || colorizable?
+
+      if pattern
+        @pattern = Regexp.compile(pattern)
+      else
+        @pattern = nil
+      end
+
+      @tp = setup_tp
+    end
+
+    def key
+      [@type, @pattern, @into].freeze
+    end
+
+    def header
+      ""
+    end
+
+    def to_s
+      s = "#{@name} #{description}"
+      s += " with pattern #{@pattern.inspect}" if @pattern
+      s
+    end
+
+    def description
+      "(#{@tp.enabled? ? "enabled" : "disabled"})"
+    end
+
+    def start(&block)
+      puts "PID:#{Process.pid} #{self}" if @output.is_a?(File)
+
+      if block
+        @tp.enable(&block)
+      else
+        @tp.enable
+        self
+      end
+    end
+
+    def stop
+      @tp.disable
+    end
+
+    def started?
+      @tp.enabled?
+    end
+
+    def stopped?
+      !started?
+    end
+
+    def skip?(tp)
+      skip_internal?(tp) || skip_with_pattern?(tp)
+    end
+
+    def skip_with_pattern?(tp)
+      @pattern && !tp.path.match?(@pattern)
+    end
+
+    def skip_internal?(tp)
+      tp.path.match?(DIR)
+    end
+
+    def out(tp, msg = nil, depth: caller.size - 1, location: nil)
+      location ||= "#{tp.path}:#{tp.lineno}"
+      buff =
+        "#{header} \#depth:#{"%-2d" % depth}#{msg} at #{colorize("#{location}", [:GREEN])}"
+
+      puts buff
+    end
+
+    def puts(msg)
+      @output.puts msg
+      @output.flush
+    end
+
+    def minfo(tp)
+      return "block{}" if tp.event == :b_call
+
+      klass = tp.defined_class
+
+      if klass.singleton_class?
+        "#{tp.self}.#{tp.method_id}"
+      else
+        "#{klass}\##{tp.method_id}"
+      end
+    end
+
+    def colorizable?
+      no_color = (nc = ENV["NO_COLOR"]).nil? || nc.empty?
+      @output.is_a?(IO) && @output.tty? && no_color
+    end
+  end
+end

data/lib/tracer/call_tracer.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+class CallTracer < Tracer::Base
+  def setup_tp
+    TracePoint.new(:a_call, :a_return) do |tp|
+      next if skip?(tp)
+
+      location = caller_locations(2, 1).first.to_s
+      next if location.match?(DIR) || location.match?(/<internal:/)
+
+      depth = caller.size
+
+      call_identifier_str = (tp.defined_class ? minfo(tp) : "block")
+      call_identifier_str = colorize_blue(call_identifier_str)
+
+      case tp.event
+      when :call, :c_call, :b_call
+        depth += 1 if tp.event == :c_call
+        sp = " " * depth
+        out tp,
+            ">#{sp}#{call_identifier_str}",
+            depth: depth - 2 - @depth_offset,
+            location: location
+      when :return, :c_return, :b_return
+        depth += 1 if tp.event == :c_return
+        sp = " " * depth
+        return_str = colorize_magenta(safe_inspect(tp.return_value))
+        out tp,
+            "<#{sp}#{call_identifier_str} #=> #{return_str}",
+            depth: depth - 2 - @depth_offset,
+            location: location
+      end
+    end
+  end
+
+  def skip_with_pattern?(tp)
+    super && !tp.method_id&.match?(@pattern)
+  end
+end