rotoscope 0.3.1.pre.1 → 0.3.1.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f72d8d9a3775c27bafb2214f668282b5defe8731e04befe0957bbd628fe99a82
-  data.tar.gz: cbc5bded38b6287945e629c6bc64fbcb1fee23c23c1ed588e04fbe2aabdb60fa
+  metadata.gz: 131b31e53265ab28834e10e524193c4140df6c4a550b97b4c069bd5144f2c0b9
+  data.tar.gz: 8bcacd887b9c1dc7dec386dfd750f2e5521da85552183211370c67292ec7ea2d
 SHA512:
-  metadata.gz: 4bd1d1a8fdea550f69513e8b36b3753684239d6cb662655cce35b4da1e4b163041265bd3771f6dd2c37e8c07b6efedef2b7b51d1d2a7f313b70adbe0e093e2d4
-  data.tar.gz: '009a2baef7ec589dd738077f523aecfa8dbc7af486a1a67eba91cd990530c494caf7134b92f9e6a83e3991bf3484bad69bd5123755cdd24440c0209378e64e80'
+  metadata.gz: 1acb66647386b79262fc77ad90433f920ffb36b75d2c7527b005abb68c377563a448b99d90e573518369171ddb05908c5a95fc5d9f88a646de72e385405c4087
+  data.tar.gz: fc010fa94e7669b902aa7285dd85bccea72781cf6cb9b3165941c6c2023491e2f945ed9b2a4f7cb87fa3f55e30c5fbb5b0857726eda1b859b3385d9370e641b9

data/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: Tests
+
+on:
+  push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - run: bundle exec rake
+
+  valgrind:
+    runs-on: ubuntu-latest
+    steps:
+    - run: sudo apt-get install -y valgrind
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true
+    - run: bundle exec rake test:valgrind

data/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

data/.rubocop.yml

@@ -1,10 +1,12 @@
-inherit_from:
-  - http://shopify.github.io/ruby-style-guide/rubocop.yml
+inherit_from: .rubocop_todo.yml
+
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 AllCops:
   Exclude:
     - 'tmp/**/*'
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.7
 
 Metrics/LineLength:
   Exclude:

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2021-10-20 17:19:27 UTC using RuboCop version 1.22.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 5
+# Configuration parameters: CheckIdentifiers, CheckConstants, CheckVariables, CheckStrings, CheckSymbols, CheckComments, CheckFilepaths, FlaggedTerms.
+Naming/InclusiveLanguage:
+  Exclude:
+    - 'lib/rotoscope/call_logger.rb'

data/Gemfile

@@ -1,3 +1,8 @@
 # frozen_string_literal: true
-source 'https://rubygems.org'
+
+source "https://rubygems.org"
 gemspec
+
+gem "rubocop", require: false
+gem "rubocop-shopify", require: false
+gem "ruby_memcheck", "~> 0.3.0", require: false

data/README.md

@@ -4,7 +4,8 @@ Rotoscope is a high-performance logger of Ruby method invocations.
 
 ## Status
 
-[![Build Status](https://travis-ci.org/Shopify/rotoscope.svg?branch=master)](https://travis-ci.org/Shopify/rotoscope) [![Gem Version](https://badge.fury.io/rb/rotoscope.svg)](https://badge.fury.io/rb/rotoscope)
+[![Build Status](https://github.com/Shopify/rotoscope/actions/workflows/ci.yml/badge.svg)](https://github.com/Shopify/rotoscope/actions?query=branch%3Amain)
+[![Gem Version](https://badge.fury.io/rb/rotoscope.svg)](https://badge.fury.io/rb/rotoscope)
 
 Rotoscope is subject to breaking changes in minor versions until `1.0` is available.
 
@@ -52,45 +53,39 @@ IO,write,instance,example/dog.rb,11,IO,puts,instance
 
 ## API
 
-- [Public Class Methods](#public-class-methods)
-  - [`trace`](#rotoscopecallloggertracedest-blacklist-)
-  - [`new`](#rotoscopecallloggernewdest-blacklist-)
-- [Public Instance Methods](#public-instance-methods)
-  - [`trace`](#rotoscopecallloggertraceblock)
-  - [`start_trace`](#rotoscopecallloggerstart_trace)
-  - [`stop_trace`](#rotoscopecallloggerstop_trace)
-  - [`mark`](#rotoscopecallloggermarkstr--)
-  - [`close`](#rotoscopecallloggerclose)
-  - [`state`](#rotoscopecallloggerstate)
-  - [`closed?`](#rotoscopecallloggerclosed)
+### Default Logging Interface
 
----
+Rotoscope ships with a default logger, `Rotoscope::CallLogger`. This provides a simple-to-use interface to the tracing engine that maintains performance as much as possible.
 
-### Public Class Methods
+- [`.trace`](#rotoscopecallloggertracedest-excludelist-)
+- [`.new`](#rotoscopecallloggernewdest-excludelist-)
+- [`#trace`](#rotoscopecallloggertraceblock)
+- [`#start_trace`](#rotoscopecallloggerstart_trace)
+- [`#stop_trace`](#rotoscopecallloggerstop_trace)
+- [`#mark`](#rotoscopecallloggermarkstr--)
+- [`#close`](#rotoscopecallloggerclose)
+- [`#state`](#rotoscopecallloggerstate)
+- [`#closed?`](#rotoscopecallloggerclosed)
 
-#### `Rotoscope::CallLogger::trace(dest, blacklist: [])`
+#### `Rotoscope::CallLogger.trace(dest, excludelist: [])`
 
-Writes all calls of methods to `dest`, except for those whose filepath contains any entry in `blacklist`. `dest` is either a filename or an `IO`. Methods invoked at the top of the trace will have a caller entity of `<ROOT>` and a caller method name of `<UNKNOWN>`.
+Writes all calls of methods to `dest`, except for those whose filepath contains any entry in `excludelist`. `dest` is either a filename or an `IO`. Methods invoked at the top of the trace will have a caller entity of `<ROOT>` and a caller method name of `<UNKNOWN>`.
 
 ```ruby
-Rotoscope::CallLogger.trace(dest) { |rs| ... }
+Rotoscope::CallLogger.trace(dest) { |call| ... }
 # or...
-Rotoscope::CallLogger.trace(dest, blacklist: ["/.gem/"]) { |rs| ... }
+Rotoscope::CallLogger.trace(dest, excludelist: ["/.gem/"]) { |call| ... }
 ```
 
-#### `Rotoscope::CallLogger::new(dest, blacklist: [])`
+#### `Rotoscope::CallLogger.new(dest, excludelist: [])`
 
 Same interface as `Rotoscope::CallLogger::trace`, but returns a `Rotoscope::CallLogger` instance, allowing fine-grain control via `Rotoscope::CallLogger#start_trace` and `Rotoscope::CallLogger#stop_trace`.
 ```ruby
 rs = Rotoscope::CallLogger.new(dest)
 # or...
-rs = Rotoscope::CallLogger.new(dest, blacklist: ["/.gem/"])
+rs = Rotoscope::CallLogger.new(dest, excludelist: ["/.gem/"])
 ```
 
----
-
-### Public Instance Methods
-
 #### `Rotoscope::CallLogger#trace(&block)`
 
 Similar to `Rotoscope::CallLogger::trace`, but does not need to create a file handle on invocation.
@@ -171,3 +166,216 @@ rs.closed? # false
 rs.close
 rs.closed? # true
 ```
+
+### Low-level API
+
+For those who prefer to define their own logging logic, Rotoscope also provides a low-level API. This is the same one used by `Rotoscope::CallLogger` internally. Users may specify a block that is invoked on each detected method call.
+
+- [`.new`](#rotoscopenewblk)
+- [`#trace`](#rotoscopetraceblk)
+- [`#start_trace`](#rotoscopestart_trace)
+- [`#stop_trace`](#rotoscopestop_trace)
+- [`#tracing?`](#rotoscopetracing)
+- [`#receiver`](#rotoscopereceiver)
+- [`#receiver_class`](#rotoscopereceiver_class)
+- [`#receiver_class_name`](#rotoscopereceiver_class_name)
+- [`#method_name`](#rotoscopemethod_name)
+- [`#singleton_method?`](#rotoscopesingleton_method)
+- [`#caller_object`](#rotoscopecaller_object)
+- [`#caller_class`](#rotoscopecaller_class)
+- [`#caller_class_name`](#rotoscopecaller_class_name)
+- [`#caller_method_name`](#rotoscopecaller_method_name)
+- [`#caller_singleton_method?`](#rotoscopecaller_singleton_method)
+- [`#caller_path`](#rotoscopecaller_path)
+- [`#caller_lineno`](#rotoscopecaller_lineno)
+
+#### `Rotoscope.new(&blk)`
+
+Creates a new instance of the `Rotoscope` class. The block argument is invoked on every call detected by Rotoscope. The block is passed the same instance returned by `Rotoscope#new` allowing the low-level methods to be called.
+
+```ruby
+rs = Rotoscope.new do |call|
+  # We likely don't want to record calls to Rotoscope
+  return if self == call.receiver
+  ...
+end
+```
+
+
+#### `Rotoscope#trace(&blk)`
+
+The equivalent of calling [`Rotoscope#start_trace`](#rotoscopestart_trace) and then [`Rotoscope#stop_trace`](#rotoscopestop_trace). The call to `#stop_trace` is within an `ensure` block so it is always called when the block terminates.
+
+```ruby
+rs = Rotoscope.new do |call|
+  ...
+end
+
+rs.trace do
+  # call some code
+end
+```
+
+#### `Rotoscope#start_trace`
+
+Begins detecting method calls invoked after this point.
+
+```ruby
+rs = Rotoscope.new do |call|
+  ...
+end
+
+rs.start_trace
+# Calls after this points invoke the
+# block passed to `Rotoscope.new`
+```
+
+#### `Rotoscope#stop_trace`
+
+Disables method call detection invoked after this point.
+
+```ruby
+rs = Rotoscope.new do |call|
+  ...
+end
+
+rs.start_trace
+...
+rs.stop_trace
+# Calls after this points will no longer
+# invoke the block passed to `Rotoscope.new`
+```
+
+#### `Rotoscope#tracing?`
+
+Identifies whether the Rotoscope object is actively tracing method calls.
+
+```ruby
+rs = Rotoscope.new do |call|
+  ...
+end
+
+rs.tracing? # => false
+rs.start_trace
+rs.tracing? # => true
+```
+
+#### `Rotoscope#receiver`
+
+Returns the object that the method is being called against.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.receiver # => #<Foo:0x00007fa3d2197c10>
+end
+```
+
+#### `Rotoscope#receiver_class`
+
+Returns the class of the object that the method is being called against.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.receiver_class # => Foo
+end
+```
+
+#### `Rotoscope#receiver_class_name`
+
+Returns the stringified class of the object that the method is being called against.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.receiver_class_name # => "Foo"
+end
+```
+
+#### `Rotoscope#method_name`
+
+Returns the name of the method being invoked.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.method_name # => "bar"
+end
+```
+
+#### `Rotoscope#singleton_method?`
+
+Returns `true` if the method called is defined at the class level. If the call is to an instance method, this returns `false`.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.singleton_method? # => false
+end
+```
+
+#### `Rotoscope#caller_object`
+
+Returns the object whose context we invoked the call from.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_object # => #<SomeClass:0x00008aa6d2cd91b61>
+end
+```
+
+#### `Rotoscope#caller_class`
+
+Returns the class of the object whose context we invoked the call from.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_class # => SomeClass
+end
+```
+
+#### `Rotoscope#caller_class_name`
+
+Returns the tringified class of the object whose context we invoked the call from.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_class_name # => "SomeClass"
+end
+```
+
+#### `Rotoscope#caller_method_name`
+
+Returns the stringified class of the object whose context we invoked the call from.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_method_name # => "call_foobar"
+end
+```
+
+#### `Rotoscope#caller_singleton_method?`
+
+Returns `true` if the method invoking the call is defined at the class level. If the call is to an instance method, this returns `false`.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_singleton_method? # => true
+end
+```
+
+#### `Rotoscope#caller_path`
+
+Returns the path to the file where the call was invoked.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_path # => "/rotoscope_test.rb"
+end
+```
+
+#### `Rotoscope#caller_lineno`
+
+Returns the line number corresponding to the `#caller_path` where the call was invoked. If unknown, returns `-1`.
+
+```ruby
+rs = Rotoscope.new do |call|
+  call.caller_lineno # => 113
+end
+```

data/Rakefile

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 # ==========================================================
 # Packaging
 # ==========================================================
-GEMSPEC = Gem::Specification.load('rotoscope.gemspec')
+GEMSPEC = Gem::Specification.load("rotoscope.gemspec")
 
-require 'bundler/gem_tasks'
-require 'rubygems/package_task'
+require "bundler/gem_tasks"
+require "rubygems/package_task"
 
 Gem::PackageTask.new(GEMSPEC) do |pkg|
 end
@@ -14,9 +15,9 @@ end
 # Ruby Extension
 # ==========================================================
 
-require 'rake/extensiontask'
-Rake::ExtensionTask.new('rotoscope', GEMSPEC) do |ext|
-  ext.lib_dir = 'lib/rotoscope'
+require "rake/extensiontask"
+Rake::ExtensionTask.new("rotoscope", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/rotoscope"
 end
 
 task(build: :compile)
@@ -29,14 +30,23 @@ end
 # Testing
 # ==========================================================
 
-require 'rake/testtask'
-Rake::TestTask.new('test') do |t|
-  t.test_files = FileList['test/*_test.rb']
+require "rake/testtask"
+require "ruby_memcheck"
+
+RubyMemcheck.config(binary_name: "rotoscope")
+
+test_config = lambda do |t|
+  t.test_files = FileList["test/*_test.rb"]
+end
+
+Rake::TestTask.new(test: :build, &test_config)
+
+namespace :test do
+  RubyMemcheck::TestTask.new(valgrind: :build, &test_config)
 end
-task(test: :build)
 
 task :rubocop do
-  require 'rubocop/rake_task'
+  require "rubocop/rake_task"
   RuboCop::RakeTask.new
 end
 

data/dev.yml

@@ -5,7 +5,7 @@ env:
   ROTOSCOPE_COMPILE_ERROR: '1'
 
 up:
-  - ruby: 2.5.3
+  - ruby: 2.7.8
   - homebrew:
     - clang-format
   - bundler

data/ext/rotoscope/callsite.c

@@ -1,4 +1,5 @@
 #include "callsite.h"
+
 #include <ruby.h>
 #include <ruby/debug.h>
 #include <stdbool.h>
@@ -7,13 +8,14 @@ static VALUE caller_frame(int *line, bool ruby_call) {
   VALUE frames[2] = {Qnil, Qnil};
   int lines[2] = {0, 0};
 
-  // At this point, the top ruby stack frame is for the method
-  // being called, so we want to skip that frame and get
-  // the caller location. This is why we use 1 for ruby calls.
+  // At this point, for ruby calls, the top ruby stack frame is
+  // for the method being called, so we want to skip that frame
+  // and get the caller location. This is why we use 1 for ruby
+  // calls.
   //
-  // However, rb_profile_frames also automatically skips over
-  // non-ruby stack frames, so we don't want to have to skip
-  // over any extra stack frames for a C call.
+  // However, for C call, the top stack frame is for the caller,
+  // so we don't want to have to skip over any extra stack frames
+  // for C calls.
   int frame_index = ruby_call ? 1 : 0;
 
   // There is currently a bug in rb_profile_frames that

data/ext/rotoscope/extconf.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
+
 require "mkmf"
 
-$CFLAGS << ' -std=c99'
-$CFLAGS << ' -Wall'
-$CFLAGS << ' -Wno-declaration-after-statement'
+$CFLAGS << " -std=c99"
+$CFLAGS << " -Wall"
+$CFLAGS << " -Wno-declaration-after-statement"
 
-unless ['0', '', nil].include?(ENV['ROTOSCOPE_COMPILE_ERROR'])
-  $CFLAGS << ' -Werror'
+unless ["0", "", nil].include?(ENV["ROTOSCOPE_COMPILE_ERROR"])
+  $CFLAGS << " -Werror"
 end
 
 $defs << "-D_POSIX_SOURCE"
 
-create_makefile('rotoscope/rotoscope')
+create_makefile("rotoscope/rotoscope")

data/ext/rotoscope/rotoscope.c

@@ -1,5 +1,6 @@
+#include "rotoscope.h"
+
 #include <errno.h>
-#include <ruby.h>
 #include <ruby/debug.h>
 #include <ruby/intern.h>
 #include <ruby/io.h>
@@ -8,15 +9,13 @@
 #include <stdio.h>
 #include <sys/file.h>
 
-#include "callsite.h"
 #include "method_desc.h"
-#include "rotoscope.h"
 #include "stack.h"
 
 VALUE cRotoscope, cTracePoint;
 ID id_initialize, id_call;
 
-static unsigned long gettid() {
+static unsigned long current_thread_id() {
   return NUM2ULONG(rb_obj_id(rb_thread_current()));
 }
 
@@ -61,7 +60,9 @@ static rs_method_desc_t called_method_desc(rb_trace_arg_t *trace_arg) {
       SYM2ID(method_id) != id_initialize;
 
   return (rs_method_desc_t){
-      .receiver = receiver, .id = method_id, .singleton_p = singleton_p,
+      .receiver = receiver,
+      .id = method_id,
+      .singleton_p = singleton_p,
   };
 }
 
@@ -99,7 +100,7 @@ static void event_hook(VALUE tpval, void *data) {
     return;
   }
 
-  if (config->tid != gettid()) return;
+  if (config->tid != current_thread_id()) return;
   if (in_fork(config)) {
     rb_tracepoint_disable(config->tracepoint);
     config->tracing = false;
@@ -131,29 +132,45 @@ static void event_hook(VALUE tpval, void *data) {
   rb_funcall(config->trace_proc, id_call, 1, config->self);
 }
 
-static void rs_gc_mark(Rotoscope *config) {
+static void rs_gc_mark(void *data) {
+  Rotoscope *config = (Rotoscope *)data;
   rb_gc_mark(config->tracepoint);
   rb_gc_mark(config->trace_proc);
   rs_stack_mark(&config->stack);
 }
 
-void rs_dealloc(Rotoscope *config) {
+static void rs_dealloc(void *data) {
+  Rotoscope *config = (Rotoscope *)data;
   stop_tracing_on_cleanup(config);
   rs_stack_free(&config->stack);
   xfree(config);
 }
 
+static size_t rs_memsize(const void *data) { return sizeof(Rotoscope); }
+
+static const rb_data_type_t rs_data_type = {
+    .wrap_struct_name = "Rotoscope",
+    .function =
+        {
+            .dmark = rs_gc_mark,
+            .dfree = rs_dealloc,
+            .dsize = rs_memsize,
+        },
+    .flags = RUBY_TYPED_FREE_IMMEDIATELY};
+
 static VALUE rs_alloc(VALUE klass) {
   Rotoscope *config;
-  VALUE self =
-      Data_Make_Struct(klass, Rotoscope, rs_gc_mark, rs_dealloc, config);
+  VALUE self = TypedData_Make_Struct(klass, Rotoscope, &rs_data_type, config);
   config->self = self;
   config->pid = getpid();
-  config->tid = gettid();
+  config->tid = current_thread_id();
   config->tracing = false;
   config->caller = NULL;
   config->callsite = (rs_callsite_t){
-      .filepath = Qnil, .lineno = 0, .method_name = Qnil, .singleton_p = Qnil,
+      .filepath = Qnil,
+      .lineno = 0,
+      .method_name = Qnil,
+      .singleton_p = Qnil,
   };
   config->trace_proc = Qnil;
   rs_stack_init(&config->stack, STACK_CAPACITY);
@@ -164,7 +181,7 @@ static VALUE rs_alloc(VALUE klass) {
 
 static Rotoscope *get_config(VALUE self) {
   Rotoscope *config;
-  Data_Get_Struct(self, Rotoscope, config);
+  TypedData_Get_Struct(self, Rotoscope, &rs_data_type, config);
   return config;
 }
 

data/ext/rotoscope/rotoscope.h

@@ -1,7 +1,10 @@
 #ifndef _INC_ROTOSCOPE_H_
 #define _INC_ROTOSCOPE_H_
 
+#include <ruby.h>
 #include <unistd.h>
+
+#include "callsite.h"
 #include "stack.h"
 
 #define EVENT_CALL (RUBY_EVENT_CALL | RUBY_EVENT_C_CALL)

data/ext/rotoscope/stack.c

@@ -1,7 +1,9 @@
 #include "stack.h"
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+
 #include "ruby.h"
 
 static void resize_buffer(rs_stack_t *stack) {
@@ -60,8 +62,10 @@ void rs_stack_init(rs_stack_t *stack, unsigned int capacity) {
 }
 
 void rs_stack_mark(rs_stack_t *stack) {
-  for (int i = 0; i <= stack->top; i++) {
-    rs_stack_frame_t *frame = &stack->contents[i];
-    rs_method_desc_mark(&frame->method);
+  if (stack->contents) {
+    for (int i = 0; i <= stack->top; i++) {
+      rs_stack_frame_t *frame = &stack->contents[i];
+      rs_method_desc_mark(&frame->method);
+    }
   }
 }

data/ext/rotoscope/stack.h

@@ -1,9 +1,12 @@
 #ifndef _INC_ROTOSCOPE_STACK_H_
 #define _INC_ROTOSCOPE_STACK_H_
 #include <stdbool.h>
+
 #include "method_desc.h"
 
-typedef struct { rs_method_desc_t method; } rs_stack_frame_t;
+typedef struct {
+  rs_method_desc_t method;
+} rs_stack_frame_t;
 
 typedef struct {
   int capacity;

data/lib/rotoscope/call_logger.rb

@@ -1,12 +1,19 @@
 # frozen_string_literal: true
 
-require 'csv'
+require "csv"
 
 class Rotoscope
   class CallLogger
+    UNSPECIFIED = Object.new
+    private_constant :UNSPECIFIED
+
     class << self
-      def trace(dest, blacklist: [])
-        rs = new(dest, blacklist: blacklist)
+      def trace(dest, blacklist: UNSPECIFIED, excludelist: [])
+        if blacklist != UNSPECIFIED
+          excludelist = blacklist
+          warn("Rotoscope::CallLogger.trace blacklist argument is deprecated, use excludelist instead")
+        end
+        rs = new(dest, excludelist: excludelist)
         rs.trace { yield rs }
         rs
       ensure
@@ -16,21 +23,30 @@ class Rotoscope
 
     HEADER = "entity,caller_entity,filepath,lineno,method_name,method_level,caller_method_name,caller_method_level\n"
 
-    attr_reader :io, :blacklist
+    attr_reader :io, :excludelist
+
+    def blacklist
+      warn("Rotoscope::CallLogger#blacklist is deprecated, use excludelist instead")
+      excludelist
+    end
 
-    def initialize(output = nil, blacklist: nil)
-      unless blacklist.is_a?(Regexp)
-        blacklist = Regexp.union(blacklist || [])
+    def initialize(output = nil, blacklist: UNSPECIFIED, excludelist: nil)
+      if blacklist != UNSPECIFIED
+        excludelist = blacklist
+        warn("Rotoscope::CallLogger#initialize blacklist argument is deprecated, use excludelist instead")
       end
-      @blacklist = blacklist
+      unless excludelist.is_a?(Regexp)
+        excludelist = Regexp.union(excludelist || [])
+      end
+      @excludelist = excludelist
 
       if output.is_a?(String)
-        @io = File.open(output, 'w')
+        @io = File.open(output, "w")
         prevent_flush_from_finalizer_in_fork(@io)
       else
         @io = output
       end
-      @output_buffer = ''.dup
+      @output_buffer = "".dup
       @pid = Process.pid
       @thread = Thread.current
 
@@ -82,38 +98,39 @@ class Rotoscope
 
     def state
       return :closed if io.closed?
+
       @rotoscope.tracing? ? :tracing : :open
     end
 
     private
 
     def log_call(call)
-      caller_path = call.caller_path || ''
-      return if blacklist.match?(caller_path)
+      caller_path = call.caller_path || ""
+      return if excludelist.match?(caller_path)
       return if self == call.receiver
 
-      caller_class_name = call.caller_class_name || '<UNKNOWN>'
+      caller_class_name = call.caller_class_name || "<UNKNOWN>"
       if call.caller_method_name.nil?
-        caller_method_name = '<UNKNOWN>'
-        caller_method_level = '<UNKNOWN>'
+        caller_method_name = "<UNKNOWN>"
+        caller_method_level = "<UNKNOWN>"
       else
         caller_method_name = escape_csv_string(call.caller_method_name)
-        caller_method_level = call.caller_singleton_method? ? 'class' : 'instance'
+        caller_method_level = call.caller_singleton_method? ? "class" : "instance"
       end
 
-      call_method_level = call.singleton_method? ? 'class' : 'instance'
+      call_method_level = call.singleton_method? ? "class" : "instance"
       method_name = escape_csv_string(call.method_name)
 
       buffer = @output_buffer
       buffer.clear
       buffer <<
         '"' << call.receiver_class_name << '",' \
-        '"' << caller_class_name << '",' \
-        '"' << caller_path << '",' \
-        << call.caller_lineno.to_s << ',' \
-        '"' << method_name << '",' \
-        << call_method_level << ',' \
-        '"' << caller_method_name << '",' \
+          '"' << caller_class_name << '",' \
+            '"' << caller_path << '",' \
+        << call.caller_lineno.to_s << "," \
+          '"' << method_name << '",' \
+        << call_method_level << "," \
+          '"' << caller_method_name << '",' \
         << caller_method_level << "\n"
       io.write(buffer)
     end
@@ -126,6 +143,7 @@ class Rotoscope
       pid = Process.pid
       finalizer = lambda do |_|
         next if Process.pid == pid
+
         # close the file descriptor from another IO object so
         # buffered writes aren't flushed
         IO.for_fd(io.fileno).close

data/lib/rotoscope/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Rotoscope
-  VERSION = "0.3.1.pre.1"
+  VERSION = "0.3.1.pre.3"
 end

data/lib/rotoscope.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-require 'rotoscope/rotoscope'
+
+require "rotoscope/rotoscope"
 
 class Rotoscope
-  autoload :CallLogger, 'rotoscope/call_logger'
+  autoload :CallLogger, "rotoscope/call_logger"
 
   def trace
     start_trace

data/rotoscope.gemspec

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
+
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "rotoscope/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'rotoscope'
+  s.name        = "rotoscope"
   s.version     = Rotoscope::VERSION
-  s.date        = '2017-09-20'
 
   s.authors     = ["Jahfer Husain", "Dylan Thacker-Smith"]
-  s.email       = 'jahfer.husain@shopify.com'
-  s.homepage    = 'https://github.com/shopify/rotoscope'
-  s.license     = 'MIT'
+  s.email       = "jahfer.husain@shopify.com"
+  s.homepage    = "https://github.com/shopify/rotoscope"
+  s.license     = "MIT"
 
   s.summary     = "Tracing Ruby"
   s.description = "High-performance logger of Ruby method invocations"
@@ -19,11 +19,12 @@ Gem::Specification.new do |s|
   s.files       = %x(git ls-files -z).split("\x0").reject do |f|
     f.match(%r{^(test)/})
   end
+  s.metadata["allowed_push_host"] = "https://rubygems.org/"
+
   s.required_ruby_version = ">= 2.2.0"
-  s.extensions = %w(ext/rotoscope/extconf.rb)
+  s.extensions = ["ext/rotoscope/extconf.rb"]
 
-  s.add_development_dependency('rake-compiler', '~> 0.9')
-  s.add_development_dependency('mocha', '~> 0.14')
-  s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('rubocop', '~> 0.56')
+  s.add_development_dependency("minitest", "~> 5.0")
+  s.add_development_dependency("mocha", "~> 0.14")
+  s.add_development_dependency("rake-compiler", "~> 0.9")
 end

data/suppressions/rotoscope_ruby-2.7.supp

@@ -0,0 +1,9 @@
+{
+  Memory leak in Ruby for versions <= 2.7.4 (see https://bugs.ruby-lang.org/issues/18264)
+  Memcheck:Leak
+  ...
+  fun:tp_alloc
+  fun:tracepoint_new
+  fun:rb_tracepoint_new
+  ...
+}

data/suppressions/rotoscope_ruby-3.0.supp

@@ -0,0 +1,9 @@
+{
+  Memory leak in Ruby for versions <= 3.0.2 (see https://bugs.ruby-lang.org/issues/18264)
+  Memcheck:Leak
+  ...
+  fun:tp_alloc
+  fun:tracepoint_new
+  fun:rb_tracepoint_new
+  ...
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotoscope
 version: !ruby/object:Gem::Version
-  version: 0.3.1.pre.1
+  version: 0.3.1.pre.3
 platform: ruby
 authors:
 - Jahfer Husain
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-20 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -40,33 +40,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '0.9'
 description: High-performance logger of Ruby method invocations
 email: jahfer.husain@shopify.com
 executables: []
@@ -76,11 +62,11 @@ extra_rdoc_files: []
 files:
 - ".clang-format"
 - ".github/PULL_REQUEST_TEMPLATE"
-- ".github/probots.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
+- ".rubocop_todo.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -100,10 +86,13 @@ files:
 - lib/rotoscope/call_logger.rb
 - lib/rotoscope/version.rb
 - rotoscope.gemspec
+- suppressions/rotoscope_ruby-2.7.supp
+- suppressions/rotoscope_ruby-3.0.supp
 homepage: https://github.com/shopify/rotoscope
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org/
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -119,8 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.4.22
 signing_key: 
 specification_version: 4
 summary: Tracing Ruby

data/.github/probots.yml

@@ -1,2 +0,0 @@
-enabled:
-  - cla

data/.ruby-version

@@ -1 +0,0 @@
-2.5.3

data/.travis.yml

@@ -1,2 +0,0 @@
-env:
-  - ROTOSCOPE_COMPILE_ERROR=1