tracer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32f50385faf52046ed48365c62f294a7d2d64fc99b5457c13e2bb7d239944883
+  data.tar.gz: 14942209dd335bdde1267eaf6382b4ce1aad47200cfa6c3af82eadb8c03fae49
+SHA512:
+  metadata.gz: 8969d4d076f10f25d0b1281d4decb8fd4c3b2aa39429e16a4771be45942b103450f7459afed93ad97bc44a73d50e9601805248729659bf9da36d50a279c0cfe7
+  data.tar.gz: a83839fd50491fcfe4374acc42be6ab8000d3335431947d6d7a12c69a5fc1e0a5875fa2afb9ce00a41f7d24a66f69a7774195869083416f184282fa7dd3a34ea

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - ruby-head
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in tracer.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,84 @@
+# 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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tracer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tracer
+
+## Usage
+
+Consider the following Ruby script
+
+```
+  class A
+    def square(a)
+      return a*a
+    end
+  end
+
+  a = A.new
+  a.square(5)
+```
+
+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
+```
+
+Symbol table used for displaying incoming events:
+
+```
++}+:: 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
+```
+
+## 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](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/tracer.
+
+## License
+
+The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tracer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/tracer.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: false
+#--
+# $Release Version: 0.3$
+# $Revision: 1.12 $
+
+##
+# 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).
+#
+# == Example
+#
+# Consider the following Ruby script
+#
+#   class A
+#     def square(a)
+#       return a*a
+#     end
+#   end
+#
+#   a = A.new
+#   a.square(5)
+#
+# 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
+#
+# Symbol table used for displaying incoming events:
+#
+# +}+:: 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
+#
+# == Copyright
+#
+# by Keiju ISHITSUKA(keiju@ishitsuka.com)
+#
+class Tracer
+
+  class << self
+    # display additional debug information (defaults to false)
+    attr_accessor :verbose
+    alias verbose? verbose
+
+    # output stream used to output trace (defaults to STDOUT)
+    attr_accessor :stdout
+
+    # mutex lock used by tracer for displaying trace output
+    attr_reader :stdout_mutex
+
+    # display process id in trace output (defaults to false)
+    attr_accessor :display_process_id
+    alias display_process_id? display_process_id
+
+    # display thread id in trace output (defaults to true)
+    attr_accessor :display_thread_id
+    alias display_thread_id? display_thread_id
+
+    # display C-routine calls in trace output (defaults to false)
+    attr_accessor :display_c_call
+    alias display_c_call? display_c_call
+  end
+
+  Tracer::stdout = STDOUT
+  Tracer::verbose = false
+  Tracer::display_process_id = false
+  Tracer::display_thread_id = true
+  Tracer::display_c_call = false
+
+  @stdout_mutex = Thread::Mutex.new
+
+  # Symbol table used for displaying trace information
+  EVENT_SYMBOL = {
+    "line" => "-",
+    "call" => ">",
+    "return" => "<",
+    "class" => "C",
+    "end" => "E",
+    "raise" => "^",
+    "c-call" => "}",
+    "c-return" => "{",
+    "unknown" => "?"
+  }
+
+  def initialize # :nodoc:
+    @threads = Hash.new
+    if defined? Thread.main
+      @threads[Thread.main.object_id] = 0
+    else
+      @threads[Thread.current.object_id] = 0
+    end
+
+    @get_line_procs = {}
+
+    @filters = []
+  end
+
+  def stdout # :nodoc:
+    Tracer.stdout
+  end
+
+  def on # :nodoc:
+    if block_given?
+      on
+      begin
+        yield
+      ensure
+        off
+      end
+    else
+      set_trace_func method(:trace_func).to_proc
+      stdout.print "Trace on\n" if Tracer.verbose?
+    end
+  end
+
+  def off # :nodoc:
+    set_trace_func nil
+    stdout.print "Trace off\n" if Tracer.verbose?
+  end
+
+  def add_filter(p = proc) # :nodoc:
+    @filters.push p
+  end
+
+  def set_get_line_procs(file, p = proc) # :nodoc:
+    @get_line_procs[file] = p
+  end
+
+  def get_line(file, line) # :nodoc:
+    if p = @get_line_procs[file]
+      return p.call(line)
+    end
+
+    unless list = SCRIPT_LINES__[file]
+      list = File.readlines(file) rescue []
+      SCRIPT_LINES__[file] = list
+    end
+
+    if l = list[line - 1]
+      l
+    else
+      "-\n"
+    end
+  end
+
+  def get_thread_no # :nodoc:
+    if no = @threads[Thread.current.object_id]
+      no
+    else
+      @threads[Thread.current.object_id] = @threads.size
+    end
+  end
+
+  def trace_func(event, file, line, id, binding, klass, *) # :nodoc:
+    return if file == __FILE__
+
+    for p in @filters
+      return unless p.call event, file, line, id, binding, klass
+    end
+
+    return unless Tracer::display_c_call? or
+      event != "c-call" && event != "c-return"
+
+    Tracer::stdout_mutex.synchronize do
+      if EVENT_SYMBOL[event]
+        stdout.printf("<%d>", $$) if Tracer::display_process_id?
+        stdout.printf("#%d:", get_thread_no) if Tracer::display_thread_id?
+        if line == 0
+          source = "?\n"
+        else
+          source = get_line(file, line)
+        end
+        stdout.printf("%s:%d:%s:%s: %s",
+               file,
+               line,
+               klass || '',
+               EVENT_SYMBOL[event],
+               source)
+      end
+    end
+
+  end
+
+  # Reference to singleton instance of Tracer
+  Single = new
+
+  ##
+  # Start tracing
+  #
+  # === Example
+  #
+  #   Tracer.on
+  #   # code to trace here
+  #   Tracer.off
+  #
+  # You can also pass a block:
+  #
+  #   Tracer.on {
+  #     # trace everything in this block
+  #   }
+
+  def Tracer.on
+    if block_given?
+      Single.on{yield}
+    else
+      Single.on
+    end
+  end
+
+  ##
+  # Disable tracing
+
+  def Tracer.off
+    Single.off
+  end
+
+  ##
+  # Register an event handler <code>p</code> which is called everytime a line
+  # in +file_name+ is executed.
+  #
+  # Example:
+  #
+  #   Tracer.set_get_line_procs("example.rb", lambda { |line|
+  #     puts "line number executed is #{line}"
+  #   })
+
+  def Tracer.set_get_line_procs(file_name, p = proc)
+    Single.set_get_line_procs(file_name, p)
+  end
+
+  ##
+  # Used to filter unwanted trace output
+  #
+  # Example which only outputs lines of code executed within the Kernel class:
+  #
+  #   Tracer.add_filter do |event, file, line, id, binding, klass, *rest|
+  #     "Kernel" == klass.to_s
+  #   end
+
+  def Tracer.add_filter(p = proc)
+    Single.add_filter(p)
+  end
+end
+
+# :stopdoc:
+SCRIPT_LINES__ = {} unless defined? SCRIPT_LINES__
+
+if $0 == __FILE__
+  # direct call
+
+  $0 = ARGV[0]
+  ARGV.shift
+  Tracer.on
+  require $0
+else
+  # call Tracer.on only if required by -r command-line option
+  count = caller.count {|bt| %r%/rubygems/core_ext/kernel_require\.rb:% !~ bt}
+  if (defined?(Gem) and count == 0) or
+     (!defined?(Gem) and count <= 1)
+    Tracer.on
+  end
+end
+# :startdoc:

data/lib/tracer/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Tracer
+  VERSION = "0.1.0"
+end

data/tracer.gemspec

@@ -0,0 +1,26 @@
+begin
+  require_relative "lib/tracer/version"
+rescue LoadError
+  # for Ruby core repository
+  require_relative "version"
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "tracer"
+  spec.version       = Tracer::VERSION
+  spec.authors       = ["Keiju ISHITSUKA"]
+  spec.email         = ["keiju@ruby-lang.org"]
+
+  spec.summary       = %q{Outputs a source level execution trace of a Ruby program.}
+  spec.description   = %q{Outputs a source level execution trace of a Ruby program.}
+  spec.homepage      = "https://github.com/ruby/tracer"
+  spec.license       = "BSD-2-Clause"
+
+  spec.files         = [".gitignore", ".travis.yml", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/tracer.rb", "lib/tracer/version.rb", "tracer.gemspec"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: tracer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keiju ISHITSUKA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Outputs a source level execution trace of a Ruby program.
+email:
+- keiju@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tracer.rb
+- lib/tracer/version.rb
+- tracer.gemspec
+homepage: https://github.com/ruby/tracer
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.0.pre1
+signing_key: 
+specification_version: 4
+summary: Outputs a source level execution trace of a Ruby program.
+test_files: []