trace_wrapper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0064e5f0a037df2776197d1bc4f037b2143bffed37c585dd2b32c3e00206eb9
+  data.tar.gz: 1fe3daabe757fae12b60deb33e28df9fc647c74c433b356bbbcce8085fef3e12
+SHA512:
+  metadata.gz: 311db8eafe42199cb782128a12bf0271d40664a4a54de3f1aea57e0a60f144ed20225338b22e0517e9a99dab8f95dab8f8b7341a31f8b40c751ce0642a6c1954
+  data.tar.gz: ed522468367180ee1c63029a6fbb5d670547e54d839bb6e149670baed46d9e8e27d6517e76ce9f6f89e42cd785ce54f5aeb2c2f302be36d1a24ab8aa8b8ef970

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.ruby-version
+doc/

data/.rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+
+Layout/LineLength:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+  IgnoredPatterns:
+    - '^.{,89}$'
+    - '[\w:]{50}'
+    - '^\s*\b(background|context|it|describe|scenario|pending|skip|(include|shared)_(examples|context)|it_behaves_like)\b.*(do|\{)?$'
+
+Metrics/AbcSize:
+  Max: 30
+  Severity: refactor
+  Exclude:
+    - '**/test/test_*.rb'
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Max: 6
+
+Naming/MethodParameterName:
+  AllowedNames:
+    - a
+    - b
+    - m
+    - n
+    - x
+    - y
+    - io
+    - id
+    - to
+    - by
+    - 'on'
+    - in
+    - at
+    - ip
+    - db
+    - os
+    - pp
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/HashEachMethods:
+  Enabled: false
+
+Style/HashTransformKeys:
+  Enabled: false
+
+Style/HashTransformValues:
+  Enabled: false
+
+Style/RescueModifier:
+  Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+cache: bundler
+rvm:
+- 2.3
+- 2.7
+- jruby
+os:
+- linux

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,33 @@
+TraceWrapper Copyright (2020) (Bill Ruddock)(“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,110 @@
+# TraceWrapper method call / return tracing
+
+[![Build Status](https://travis-ci.org/biinari/trace_wrapper.svg?branch=master)](https://travis-ci.org/biinari/trace_wrapper)
+
+TraceWrapper outputs method call and return info for a class or module
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trace_wrapper'
+```
+
+Or install it generally with:
+
+```sh
+$ gem install trace_wrapper
+```
+
+## Usage
+
+A simple example of a module and a class to be traced:
+
+```ruby
+module MyModule
+  module_function
+
+  def something_else
+    puts 'What else?'
+  end
+end
+
+class MyClass
+  def self.forty(two: 2)
+    40 + two
+  end
+
+  def plus_two(x)
+    x + 2
+  end
+end
+```
+
+A basic example of tracing our sample class and module:
+
+```ruby
+TraceWrapper.wrap(MyClass, MyModule) do
+  puts MyModule.subject
+  puts MyClass.meaning(x: 40)
+end
+```
+
+Will output the following (with the tracing all indented by at least 2 spaces):
+
+```
+  MyModule.subject()
+  MyModule.subject return "What is the answer …"
+What is the answer to the ultimate question?
+  MyClass.meaning(x: 40)
+    MyClass#plus_two(40)
+    MyClass#plus_two return 42
+  MyClass.meaning return 42
+42
+```
+
+See [custom example](examples/custom.rb) for a more custom usage
+
+### Options
+
+Options for `TraceWrapper.new`
+
+* `:colour` - Enable coloured output (default: `nil` automatically enables colour if output is a TTY)
+* `:output` - Specify output `IO` (default: `STDOUT`)
+
+Options for `TraceWrapper#wrap`
+
+* `:method_type` - Which type of methods to wrap
+
+It is also supported to run `TraceWrapper.wrap` with options available to `.new` and the instance method `#wrap`.
+
+Sample usage with all options:
+
+```ruby
+tracer = TraceWrapper.new(colour: true, output: STDERR)
+tracer.wrap(MyClass, method_type: :instance_methods)
+MyClass.new.plus_two(40)
+tracer.unwrap
+
+# or in a single call
+TraceWrapper.wrap(MyClass, colour: false, method_type: :methods) do
+  MyClass.meaning(x: 40)
+end
+```
+
+## Testing
+
+Run the tests with `rake` or directly with:
+
+```ruby
+bundle exec ruby test/test_trace_wrapper.rb
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch
+3. Commit your changes
+4. Push to your branch
+5. Create a Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :rubocop do
+  sh 'rubocop'
+end
+
+task default: %i[rubocop test]

data/examples/basic.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../lib/trace_wrapper'
+
+module MyModule
+  module_function
+
+  def subject
+    'What is the answer to the ultimate question?'
+  end
+end
+
+class MyClass
+  def self.meaning(x: 1)
+    new.plus_two(x)
+  end
+
+  def plus_two(x)
+    x + 2
+  end
+end
+
+TraceWrapper.wrap(MyModule, MyClass) do
+  puts MyModule.subject
+  puts MyClass.meaning(x: 40)
+end

data/examples/custom.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative '../lib/trace_wrapper'
+
+module MyModule
+  module_function
+
+  def subject
+    'What is the answer to the ultimate question?'
+  end
+end
+
+class MyClass
+  def self.meaning(x: 1)
+    new.plus_two(x)
+  end
+
+  def plus_two(x)
+    x + 2
+  end
+end
+
+tracer = TraceWrapper.new(colour: false, output: STDERR)
+tracer.wrap(MyModule, method_type: :methods)
+tracer.wrap(MyClass, method_type: :all)
+
+puts MyModule.subject
+puts MyClass.meaning(x: 40)
+
+tracer.unwrap

data/lib/trace_wrapper/version.rb

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

data/lib/trace_wrapper.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+require 'trace_wrapper/version'
+
+##
+# Wraps methods on given classes or modules to output a call/return tree.
+class TraceWrapper
+  COLOURS = {
+    red: '31m',
+    b_red: '1;31m',
+    green: '32m',
+    b_green: '1;32m',
+    orange: '33m',
+    yellow: '1;33m',
+    blue: '34m',
+    b_blue: '1;34m',
+    purple: '35m',
+    b_purple: '1;35m',
+    teal: '36m',
+    cyan: '1;36m'
+  }.freeze
+
+  ELLIPSIS = "\u2026"
+
+  class << self
+    def wrap(*receivers, **kwargs, &block)
+      init_keys = %i[output colour]
+      init_args = kwargs.select { |k, _| init_keys.include?(k) }
+      wrap_args = kwargs.reject { |k, _| init_keys.include?(k) }
+
+      new(**init_args).wrap(*receivers, **wrap_args, &block)
+    end
+  end
+
+  ##
+  # Create a new +TraceWrapper+
+  #
+  # Options:
+  #
+  # :output - +IO+ object to write trace output to (default +STDOUT+)
+  # :colour - True to use shell colours in output (default +nil+ will colour if
+  #           output is a TTY)
+  def initialize(output: $stdout, colour: nil)
+    @output = output
+    @colour = colour
+    @unwrappers = []
+    @main_process_id = process_id
+    @processes = {}
+    process
+  end
+
+  ##
+  # Wraps methods on given +receivers+ with tracing
+  #
+  # Options
+  #
+  # :method_type - Types of methods to wrap (default: :all). Choices are:
+  #                :instance for methods on instances of receiver(s)
+  #                :self for methods called directly on the receiver(s)
+  #                :all for both
+  # :visibility - Array of method visibility levels to wrap. Can include
+  #               :public, :protected, :private
+  #               (default [:public, :protected])
+  #
+  # If a block is given, the wrappers will be created just around the block
+  def wrap(*receivers,
+           method_type: :all,
+           visibility: %i[public protected])
+    unwrappers = []
+    Array(*receivers).each do |receiver|
+      if %i[all self].include?(method_type)
+        unwrappers += wrap_methods(receiver, visibility: visibility)
+      end
+      if %i[all instance].include?(method_type)
+        unwrappers += wrap_instance_methods(receiver, visibility: visibility)
+      end
+    end
+    if block_given?
+      begin
+        yield(self)
+      ensure
+        unwrappers.each(&:call)
+      end
+    else
+      @unwrappers += unwrappers
+      self
+    end
+  end
+
+  # Remove any wrappers set by this tracer
+  def unwrap
+    @unwrappers.each(&:call)
+    @unwrappers = []
+  end
+
+  private
+
+  # Wrap standard methods (methods on the object given) with tracing
+  def wrap_methods(*receivers, visibility: %i[public protected])
+    unwrappers = []
+    Array(*receivers).each do |receiver|
+      mod, unwrapper = wrapping_module(receiver, :self, visibility)
+      unwrappers << unwrapper
+      receiver.singleton_class.send(:prepend, mod)
+    end
+    unwrappers
+  end
+
+  # Wrap instance methods (called on an instance of the class given) with
+  # tracing
+  def wrap_instance_methods(*receivers, visibility: %i[public protected])
+    unwrappers = []
+    Array(*receivers).each do |receiver|
+      mod, unwrapper = wrapping_module(receiver, :instance, visibility)
+      unwrappers << unwrapper
+      receiver.send(:prepend, mod)
+    end
+    unwrappers
+  end
+
+  def wrapping_module(receiver, method_type, visibility)
+    method_names = get_methods(receiver, method_type, visibility)
+    get_method = method_type == :instance ? :instance_method : :method
+    dot = method_type == :instance ? '#' : '.'
+    trace_call = method(:trace_call)
+    trace_return = method(:trace_return)
+    key_args = method(:key_args?)
+
+    mod = Module.new do
+      method_names.each do |name|
+        wrap_method =
+          if key_args.call(receiver.public_send(get_method, name))
+            lambda do |*args, **kwargs, &block|
+              trace_call.call(receiver, dot, name, *args, **kwargs)
+              result = super(*args, **kwargs, &block)
+              trace_return.call(receiver, dot, name, result)
+              result
+            end
+          else
+            lambda do |*args, &block|
+              trace_call.call(receiver, dot, name, *args)
+              result = super(*args, &block)
+              trace_return.call(receiver, dot, name, result)
+              result
+            end
+          end
+        define_method(name, wrap_method)
+      end
+    end
+    unwrapper = lambda do
+      method_names.each do |name|
+        mod.send(:remove_method, name) if mod.method_defined?(name)
+      end
+    end
+    [mod, unwrapper]
+  end
+
+  LIST_METHODS = {
+    instance: {
+      public: :public_instance_methods,
+      protected: :protected_instance_methods,
+      private: :private_instance_methods
+    },
+    self: {
+      public: :public_methods,
+      protected: :protected_methods,
+      private: :private_methods
+    }
+  }.freeze
+
+  def get_methods(receiver, method_type, visibility)
+    %i[public protected private].map do |vis|
+      next unless visibility.include?(vis)
+
+      lister = LIST_METHODS[method_type][vis]
+      receiver.public_send(lister, false) - Object.public_send(lister)
+    end.compact.flatten
+  end
+
+  def trace_call(receiver, dot, method_name, *args, **kwargs)
+    writeln("#{show_pid}#{function(receiver, dot, method_name)}" \
+            "(#{show_args(*args, **kwargs)})")
+    incr_indent
+  end
+
+  def trace_return(receiver, dot, method_name, result)
+    decr_indent
+    writeln("#{show_pid}#{function(receiver, dot, method_name)} " \
+            "#{colour('return', :yellow)} " \
+            "#{colour(short_inspect(result), :purple)}")
+  end
+
+  def key_args?(method)
+    method.parameters.any? { |k, _| %i[keyrest key].include?(k) }
+  end
+
+  def main
+    TOPLEVEL_BINDING.receiver
+  end
+
+  def function(receiver, dot, name)
+    return colour(id, :teal) if main == receiver
+
+    "#{colour(receiver, :b_green)}#{dot}#{colour(name, :teal)}"
+  end
+
+  def writeln(text)
+    @output.write("#{indent}#{text}\n")
+  end
+
+  def colour(text, colour)
+    return text unless colour?
+    "\e[#{COLOURS[colour]}#{text}\e[0m"
+  end
+
+  def colour?
+    return @colour unless @colour.nil?
+    @output.respond_to?(:isatty) && @output.isatty
+  end
+
+  def incr_indent
+    process[:indent] += 1
+  end
+
+  def decr_indent
+    process[:indent] = [process[:indent] - 1, 0].max
+  end
+
+  def indent
+    '  ' * (process[:indent] + 1)
+  end
+
+  def process
+    proc_colours = %i[b_purple orange blue red purple cyan yellow b_blue b_red]
+    @processes[process_id.join(':')] ||= {
+      colour: proc_colours[@processes.size],
+      indent: 0
+    }
+  end
+
+  def process_id
+    [Process.pid, Thread.current.hash]
+  end
+
+  def process_label
+    return if process_id == @main_process_id
+    pid, tid = process_id
+    return pid if Thread.current == Thread.main
+    pid = '' if pid == @main_process_id.first
+    "#{pid}:#{tid.to_s[-4..-1]}"
+  end
+
+  def show_pid
+    return if process_id == @main_process_id
+    colour("[#{process_label}]", process[:colour])
+  end
+
+  def show_args(*args, **kwargs)
+    return if args.empty? && kwargs.empty?
+    parts = args.map do |v|
+      colour(short_inspect(v), :purple)
+    end
+    parts += kwargs.map do |k, v|
+      "#{k}: #{colour(short_inspect(v), :purple)}"
+    end
+    parts.join(', ')
+  end
+
+  def short_inspect(obj, limit = 20)
+    text = obj.inspect
+    return text if text.length <= limit
+    text[0...limit] + ELLIPSIS + text[-1]
+  end
+end

data/test/playground.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module PlayModule
+  module_function
+
+  def one(text)
+    "#{text} and a one"
+  end
+
+  def two(*args, **kwargs)
+    yield(*args, **kwargs)
+  end
+end
+
+class PlayClass
+  class << self
+    def play_hello
+      new.play('hello', 'world')
+    end
+  end
+
+  def play(*args)
+    args.map(&:to_s).join(', ')
+  end
+
+  def play_friendly(*args)
+    friendly(*args)
+  end
+
+  def play_solitaire(*args)
+    solitaire(*args)
+  end
+
+  protected
+
+  def friendly(*args)
+    "friends: #{args.map(&:to_s).join(', ')}"
+  end
+
+  private
+
+  def solitaire(*args)
+    "solo: #{args.map(&:to_s).join(', ')}"
+  end
+end
+
+module PlayArgs
+  module_function
+
+  def full(x, y = 1, a: 3)
+    [x, y, a]
+  end
+
+  def full_rest(x, y = 1, *args, a: 2, **kwargs, &block)
+    block.call(x, y, *args, a: a, **kwargs)
+  end
+
+  def rest(*args)
+    args
+  end
+
+  def key_rest(**kwargs)
+    kwargs
+  end
+
+  def both_rest(*args, **kwargs)
+    [args, kwargs]
+  end
+end
+
+class PlayFib
+  # Naive fibonacci implementation (we want to test some deep nesting)
+  def fib(n)
+    raise ArgumentError, 'Must be positive' if n.negative?
+    return 1 if n <= 1
+
+    fib(n - 1) + fib(n - 2)
+  end
+end

data/test/test_trace_wrapper.rb

@@ -0,0 +1,313 @@
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../lib', __dir__)
+
+require 'minitest/autorun'
+require 'minitest/pride'
+
+require 'trace_wrapper'
+require File.expand_path('playground', __dir__)
+
+class TestTraceWrapper < Minitest::Test
+  class Output
+    attr_reader :output
+
+    def initialize
+      @output = []
+    end
+
+    def write(text)
+      text = text.to_s unless text.is_a?(String)
+      @output << text
+    end
+  end
+
+  class Pipe
+    def initialize
+      @reader, @writer = IO.pipe
+    end
+
+    def write(*args)
+      @writer.write(*args)
+    end
+
+    def read(*args)
+      @reader.read(*args)
+    end
+
+    def close
+      @writer.close
+    end
+  end
+
+  ::TraceWrapper::COLOURS.each do |k, v|
+    const_set(k.upcase, "\e[#{v}")
+  end
+  CLEAR = "\e[0m"
+  ELLIPSIS = "\u2026"
+  RETURN = "#{YELLOW}return#{CLEAR}"
+
+  def strip_colour(text)
+    text.gsub(/\e\[(?:1;)?\d+m/, '')
+  end
+
+  def assert_equal_output(expected_output, **tracer_options)
+    output = Output.new
+    opts = tracer_options.merge(output: output)
+    tracer = ::TraceWrapper.new(**opts)
+    yield(tracer)
+
+    assert_equal(expected_output, output.output.join)
+  ensure
+    tracer.unwrap
+  end
+
+  def test_wrap_output_module
+    mod_name = "#{B_GREEN}PlayModule#{CLEAR}"
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      MOD.TWO()
+        MOD.ONE(#{PURPLE}"abc"#{CLEAR})
+        MOD.ONE RETURN #{PURPLE}"abc and a one"#{CLEAR}
+      MOD.TWO RETURN #{PURPLE}"abc and a one"#{CLEAR}
+    OUTPUT
+    expected_output.gsub!('MOD', mod_name)
+                   .gsub!('RETURN', RETURN)
+                   .gsub!('ONE', "#{TEAL}one#{CLEAR}")
+                   .gsub!('TWO', "#{TEAL}two#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayModule, method_type: :self)
+      result = PlayModule.two do
+        PlayModule.one('abc')
+      end
+
+      assert_equal('abc and a one', result)
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_wrap_output_class
+    cls_name = "#{B_GREEN}PlayClass#{CLEAR}"
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      CLASS.PLAY_HELLO()
+        CLASS#PLAY(#{PURPLE}"hello"#{CLEAR}, #{PURPLE}"world"#{CLEAR})
+        CLASS#PLAY RETURN #{PURPLE}"hello, world"#{CLEAR}
+      CLASS.PLAY_HELLO RETURN #{PURPLE}"hello, world"#{CLEAR}
+    OUTPUT
+    expected_output.gsub!('CLASS', cls_name)
+                   .gsub!('RETURN', RETURN)
+                   .gsub!('PLAY_HELLO', "#{TEAL}play_hello#{CLEAR}")
+                   .gsub!('PLAY', "#{TEAL}play#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayClass)
+      result = PlayClass.play_hello
+
+      assert_equal('hello, world', result)
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_wrap_output_protected_methods
+    cls_name = "#{B_GREEN}PlayClass#{CLEAR}"
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      CLASS#PLAY_FRIENDLY(@1@)
+        CLASS#FRIENDLY(@1@)
+        CLASS#FRIENDLY RETURN @"friends: 1"@
+      CLASS#PLAY_FRIENDLY RETURN @"friends: 1"@
+    OUTPUT
+    expected_output.gsub!('CLASS', cls_name)
+                   .gsub!('RETURN', RETURN)
+                   .gsub!('PLAY_FRIENDLY', "#{TEAL}play_friendly#{CLEAR}")
+                   .gsub!('FRIENDLY', "#{TEAL}friendly#{CLEAR}")
+                   .gsub!(/@([^@]*)@/, "#{PURPLE}\\1#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayClass)
+      result = PlayClass.new.play_friendly(1)
+
+      assert_equal('friends: 1', result)
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_wrap_output_private_methods
+    cls_name = "#{B_GREEN}PlayClass#{CLEAR}"
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      CLASS#PLAY_SOLITAIRE(@2@, @3@)
+        CLASS#SOLITAIRE(@2@, @3@)
+        CLASS#SOLITAIRE RETURN @"solo: 2, 3"@
+      CLASS#PLAY_SOLITAIRE RETURN @"solo: 2, 3"@
+    OUTPUT
+    expected_output.gsub!('CLASS', cls_name)
+                   .gsub!('RETURN', RETURN)
+                   .gsub!('PLAY_SOLITAIRE', "#{TEAL}play_solitaire#{CLEAR}")
+                   .gsub!('SOLITAIRE', "#{TEAL}solitaire#{CLEAR}")
+                   .gsub!(/@([^@]*)@/, "#{PURPLE}\\1#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayClass, visibility: %i[public protected private])
+      result = PlayClass.new.play_solitaire(2, 3)
+
+      assert_equal('solo: 2, 3', result)
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_wrap_output_class_nesting
+    cls_name = "#{B_GREEN}PlayFib#{CLEAR}"
+    fib = "#{TEAL}fib#{CLEAR}"
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      SIG(ARG(4))
+        SIG(ARG(3))
+          SIG(ARG(2))
+            SIG(ARG(1))
+            SIG RETURN ARG(1)
+            SIG(ARG(0))
+            SIG RETURN ARG(1)
+          SIG RETURN ARG(2)
+          SIG(ARG(1))
+          SIG RETURN ARG(1)
+        SIG RETURN ARG(3)
+        SIG(ARG(2))
+          SIG(ARG(1))
+          SIG RETURN ARG(1)
+          SIG(ARG(0))
+          SIG RETURN ARG(1)
+        SIG RETURN ARG(2)
+      SIG RETURN ARG(5)
+    OUTPUT
+    expected_output.gsub!('SIG', "#{cls_name}##{fib}")
+                   .gsub!('RETURN', RETURN)
+                   .gsub!(/ARG\((\d+)\)/, "#{PURPLE}\\1#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayFib, method_type: :instance)
+      result = PlayFib.new.fib(4)
+
+      assert_equal(5, result)
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_wrap_args
+    mod_name = "#{B_GREEN}PlayArgs#{CLEAR}"
+    methods_pattern = /\b(full(?:_rest)?|(?:key_|both_)?rest)\b/
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      MOD.full(@3@, @4@, a: @5@)
+      MOD.full RETURN @[3, 4, 5]@
+      MOD.full_rest(@5@, @6@, @7@, a: @1@, b: @2@)
+      MOD.full_rest RETURN @[[5, 6, 7], {:a=>1, #{ELLIPSIS}]@
+      MOD.rest(@42@, @"b"@)
+      MOD.rest RETURN @[42, "b"]@
+      MOD.key_rest(a: @"a"@, b: @nil@)
+      MOD.key_rest RETURN @{:a=>"a", :b=>nil}@
+      MOD.both_rest(@12@, @"d"@, a: @nil@, b: @9@)
+      MOD.both_rest RETURN @[[12, "d"], {:a=>nil#{ELLIPSIS}]@
+    OUTPUT
+    expected_output.gsub!('MOD', mod_name)
+                   .gsub!('RETURN', RETURN)
+                   .gsub!(methods_pattern, "#{TEAL}\\1#{CLEAR}")
+                   .gsub!(/@([^@]*)@/, "#{PURPLE}\\1#{CLEAR}")
+
+    subject = lambda do |tracer|
+      tracer.wrap(PlayArgs)
+      assert_equal([3, 4, 5], PlayArgs.full(3, 4, a: 5))
+      assert_equal([[5, 6, 7], { a: 1, b: 2 }],
+                   PlayArgs.full_rest(5, 6, 7, a: 1, b: 2) do |*args, **kwargs|
+                     [args, kwargs]
+                   end)
+      assert_equal([42, 'b'], PlayArgs.rest(42, 'b'))
+      assert_equal({ a: 'a', b: nil }, PlayArgs.key_rest(a: 'a', b: nil))
+      assert_equal([[12, 'd'], { a: nil, b: 9 }],
+                   PlayArgs.both_rest(12, 'd', a: nil, b: 9))
+    end
+
+    assert_equal_output(strip_colour(expected_output), colour: false, &subject)
+    assert_equal_output(expected_output, colour: true, &subject)
+  end
+
+  def test_trace_process_label_thread
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      MOD.ONE(@"a"@)
+      MOD.ONE RETURN @"a and a one"@
+      #{ORANGE}[:THREAD_ID]#{CLEAR}MOD.ONE(@2@)
+      #{ORANGE}[:THREAD_ID]#{CLEAR}MOD.ONE RETURN @"2 and a one"@
+    OUTPUT
+    expected_output.gsub!('MOD', "#{B_GREEN}PlayModule#{CLEAR}")
+                   .gsub!('ONE', "#{TEAL}one#{CLEAR}")
+                   .gsub!('RETURN', "#{YELLOW}return#{CLEAR}")
+                   .gsub!(/@([^@]*)@/, "#{PURPLE}\\1#{CLEAR}")
+
+    [false, true].each do |colour|
+      output = Output.new
+      tracer = TraceWrapper.new(output: output, colour: colour)
+      thread = nil
+      tracer.wrap(PlayModule) do
+        assert_equal('a and a one', PlayModule.one('a'))
+        thread = Thread.new { PlayModule.one(2) }
+        thread.join
+      end
+      exp = expected_output.gsub('THREAD_ID', thread.hash.to_s[-4..-1])
+      exp = strip_colour(exp) unless colour
+      assert_equal(exp, output.output.join)
+    end
+  end
+
+  def test_trace_process_label_fork
+    skip 'Process.fork unavailable' unless Process.respond_to?(:fork)
+
+    expected_output = <<-OUTPUT.gsub(/^ {4}/, '')
+      #{ORANGE}[PROCESS_ID]#{CLEAR}MOD.ONE(@3@)
+      #{ORANGE}[PROCESS_ID]#{CLEAR}MOD.ONE RETURN @"3 and a one"@
+      #{BLUE}[PROCESS_ID:THREAD_ID]#{CLEAR}MOD.ONE(@4@)
+      #{BLUE}[PROCESS_ID:THREAD_ID]#{CLEAR}MOD.ONE RETURN @"4 and a one"@
+    OUTPUT
+    expected_output.gsub!('MOD', "#{B_GREEN}PlayModule#{CLEAR}")
+                   .gsub!('ONE', "#{TEAL}one#{CLEAR}")
+                   .gsub!('RETURN', "#{YELLOW}return#{CLEAR}")
+                   .gsub!(/@([^@]*)@/, "#{PURPLE}\\1#{CLEAR}")
+
+    [false, true].each do |colour|
+      pipe = Pipe.new
+      thread_pipe = Pipe.new
+
+      tracer = TraceWrapper.new(output: pipe, colour: colour)
+      pid = nil
+      tracer.wrap(PlayModule) do
+        pid = Process.fork do
+          PlayModule.one(3)
+          thread = Thread.new { PlayModule.one(4) }
+          thread.join
+          thread_pipe.write(thread.hash.to_s[-4..-1])
+
+          pipe.close
+          thread_pipe.close
+        end
+        pipe.close
+        thread_pipe.close
+        Process.wait(pid)
+      end
+      exp = expected_output.gsub('PROCESS_ID', pid.to_s)
+                           .gsub('THREAD_ID', thread_pipe.read)
+      exp = strip_colour(exp) unless colour
+      assert_equal(exp, pipe.read)
+    end
+  end
+end

data/trace_wrapper.gemspec

@@ -0,0 +1,29 @@
+require 'English'
+
+require File.expand_path('lib/trace_wrapper/version', __dir__)
+
+Gem::Specification.new do |s|
+  s.name = 'trace_wrapper'
+  s.version = TraceWrapper::VERSION
+  s.license = 'Hippocratic-2.1'
+  s.summary = 'TraceWrapper outputs method call and returns for a class'
+  s.description = 'Wrap the methods of a class or module to output call info.
+
+  See a tree of calls made to wrapped methods with argument values and return
+  values.'
+  s.authors = ['Bill Ruddock']
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files = s.files.grep(%r{test/})
+  s.require_paths = ['lib']
+
+  s.homepage = 'https://github.com/biinari/trace_wrapper'
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/biinari/trace_wrapper'
+  }
+  s.rdoc_options << '--main' << 'README.md'
+
+  s.add_development_dependency 'minitest', '~> 5.14'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rubocop', '~> 0.80.1'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: trace_wrapper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bill Ruddock
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+description: |-
+  Wrap the methods of a class or module to output call info.
+
+    See a tree of calls made to wrapped methods with argument values and return
+    values.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- examples/basic.rb
+- examples/custom.rb
+- lib/trace_wrapper.rb
+- lib/trace_wrapper/version.rb
+- test/playground.rb
+- test/test_trace_wrapper.rb
+- trace_wrapper.gemspec
+homepage: https://github.com/biinari/trace_wrapper
+licenses:
+- Hippocratic-2.1
+metadata:
+  source_code_uri: https://github.com/biinari/trace_wrapper
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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.1.2
+signing_key: 
+specification_version: 4
+summary: TraceWrapper outputs method call and returns for a class
+test_files:
+- test/playground.rb
+- test/test_trace_wrapper.rb