rotoscope 0.3.0 → 0.3.1.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da519185af3cb3652183905a5005c9666a8479d97075ed258524c2dbae41a22f
-  data.tar.gz: 9afac7ae131260c434e77a2238b631f0674019a6f3abf71713a525f507a95890
+  metadata.gz: f72d8d9a3775c27bafb2214f668282b5defe8731e04befe0957bbd628fe99a82
+  data.tar.gz: cbc5bded38b6287945e629c6bc64fbcb1fee23c23c1ed588e04fbe2aabdb60fa
 SHA512:
-  metadata.gz: bad9b2c953384b6dde92fc6cbef2a5975dd16a92e86f9b355f1ae3a6c1e5fa6715f0837a3812794fae7759bf1d7391f9adc36a515e7a1640cea913fda12e7b57
-  data.tar.gz: eac7f35d1d1b0346f047c87eebda7cf47d59ed5dff9bc4ab073601071eb17b9f6b107216812803fa9ba13d62805c548374f5c49cca60fb9ff5de656214ee06a9
+  metadata.gz: 4bd1d1a8fdea550f69513e8b36b3753684239d6cb662655cce35b4da1e4b163041265bd3771f6dd2c37e8c07b6efedef2b7b51d1d2a7f313b70adbe0e093e2d4
+  data.tar.gz: '009a2baef7ec589dd738077f523aecfa8dbc7af486a1a67eba91cd990530c494caf7134b92f9e6a83e3991bf3484bad69bd5123755cdd24440c0209378e64e80'

data/.ruby-version

@@ -1 +1 @@
-2.4.3
+2.5.3

data/dev.yml

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

data/ext/rotoscope/callsite.c

@@ -1,39 +1,50 @@
 #include "callsite.h"
 #include <ruby.h>
 #include <ruby/debug.h>
+#include <stdbool.h>
 
-VALUE empty_ruby_string;
+static VALUE caller_frame(int *line, bool ruby_call) {
+  VALUE frames[2] = {Qnil, Qnil};
+  int lines[2] = {0, 0};
 
-rs_callsite_t c_callsite(rb_trace_arg_t *trace_arg) {
-  VALUE path = rb_tracearg_path(trace_arg);
-  return (rs_callsite_t){
-      .filepath = NIL_P(path) ? empty_ruby_string : path,
-      .lineno = FIX2INT(rb_tracearg_lineno(trace_arg)),
-  };
-}
+  // 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.
+  //
+  // 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.
+  int frame_index = ruby_call ? 1 : 0;
 
-rs_callsite_t ruby_callsite(rb_trace_arg_t *trace_arg) {
-  VALUE frames[2];
-  int lines[2];
   // There is currently a bug in rb_profile_frames that
   // causes the start argument to effectively always
   // act as if it were 0, so we need to also get the top
-  // frame.
-  if (rb_profile_frames(0, 2, frames, lines) < 2) {
-    return (rs_callsite_t){
-        .filepath = empty_ruby_string,
-        .lineno = 0,
-    };
-  }
+  // frame. (https://bugs.ruby-lang.org/issues/14607)
+  rb_profile_frames(0, frame_index + 1, frames, lines);
+
+  *line = lines[frame_index];
+  return frames[frame_index];
+}
 
+rs_callsite_t c_callsite(rb_trace_arg_t *trace_arg) {
+  int line;
+  VALUE frame = caller_frame(&line, false);
   return (rs_callsite_t){
-      .filepath = rb_profile_frame_path(frames[1]),
-      .lineno = lines[1],
+      .filepath = rb_tracearg_path(trace_arg),
+      .lineno = FIX2INT(rb_tracearg_lineno(trace_arg)),
+      .method_name = rb_profile_frame_method_name(frame),
+      .singleton_p = rb_profile_frame_singleton_method_p(frame),
   };
 }
 
-void init_callsite() {
-  empty_ruby_string = rb_str_new_literal("");
-  RB_OBJ_FREEZE(empty_ruby_string);
-  rb_global_variable(&empty_ruby_string);
+rs_callsite_t ruby_callsite() {
+  int line;
+  VALUE frame = caller_frame(&line, true);
+
+  return (rs_callsite_t){
+      .filepath = rb_profile_frame_path(frame),
+      .lineno = line,
+      .method_name = rb_profile_frame_method_name(frame),
+      .singleton_p = rb_profile_frame_singleton_method_p(frame),
+  };
 }

data/ext/rotoscope/callsite.h

@@ -7,11 +7,11 @@
 typedef struct {
   VALUE filepath;
   unsigned int lineno;
+  VALUE method_name;
+  VALUE singleton_p;
 } rs_callsite_t;
 
-void init_callsite();
-
 rs_callsite_t c_callsite(rb_trace_arg_t *trace_arg);
-rs_callsite_t ruby_callsite(rb_trace_arg_t *trace_arg);
+rs_callsite_t ruby_callsite();
 
 #endif

data/ext/rotoscope/rotoscope.c

@@ -49,7 +49,7 @@ static rs_callsite_t tracearg_path(rb_trace_arg_t *trace_arg) {
     case RUBY_EVENT_C_CALL:
       return c_callsite(trace_arg);
     default:
-      return ruby_callsite(trace_arg);
+      return ruby_callsite();
   }
 }
 
@@ -61,9 +61,7 @@ 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,
   };
 }
 
@@ -154,8 +152,9 @@ static VALUE rs_alloc(VALUE klass) {
   config->tid = gettid();
   config->tracing = false;
   config->caller = NULL;
-  config->callsite.filepath = Qnil;
-  config->callsite.lineno = 0;
+  config->callsite = (rs_callsite_t){
+      .filepath = Qnil, .lineno = 0, .method_name = Qnil, .singleton_p = Qnil,
+  };
   config->trace_proc = Qnil;
   rs_stack_init(&config->stack, STACK_CAPACITY);
   config->tracepoint = rb_tracepoint_new(Qnil, EVENT_CALL | EVENT_RETURN,
@@ -264,18 +263,12 @@ VALUE rotoscope_caller_class_name(VALUE self) {
 
 VALUE rotoscope_caller_method_name(VALUE self) {
   Rotoscope *config = get_config(self);
-  if (config->caller == NULL) {
-    return Qnil;
-  }
-  return rb_sym2str(config->caller->method.id);
+  return config->callsite.method_name;
 }
 
 VALUE rotoscope_caller_singleton_method_p(VALUE self) {
   Rotoscope *config = get_config(self);
-  if (config->caller == NULL) {
-    return Qnil;
-  }
-  return config->caller->method.singleton_p ? Qtrue : Qfalse;
+  return config->callsite.singleton_p;
 }
 
 VALUE rotoscope_caller_path(VALUE self) {
@@ -317,6 +310,4 @@ void Init_rotoscope(void) {
                    rotoscope_caller_singleton_method_p, 0);
   rb_define_method(cRotoscope, "caller_path", rotoscope_caller_path, 0);
   rb_define_method(cRotoscope, "caller_lineno", rotoscope_caller_lineno, 0);
-
-  init_callsite();
 }

data/ext/rotoscope/stack.h

@@ -3,9 +3,7 @@
 #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

@@ -88,15 +88,15 @@ class Rotoscope
     private
 
     def log_call(call)
-      return if blacklist.match?(call.caller_path)
+      caller_path = call.caller_path || ''
+      return if blacklist.match?(caller_path)
       return if self == call.receiver
 
+      caller_class_name = call.caller_class_name || '<UNKNOWN>'
       if call.caller_method_name.nil?
-        caller_class_name = '<ROOT>'
         caller_method_name = '<UNKNOWN>'
         caller_method_level = '<UNKNOWN>'
       else
-        caller_class_name = call.caller_class_name
         caller_method_name = escape_csv_string(call.caller_method_name)
         caller_method_level = call.caller_singleton_method? ? 'class' : 'instance'
       end
@@ -109,7 +109,7 @@ class Rotoscope
       buffer <<
         '"' << call.receiver_class_name << '",' \
         '"' << caller_class_name << '",' \
-        '"' << call.caller_path << '",' \
+        '"' << caller_path << '",' \
         << call.caller_lineno.to_s << ',' \
         '"' << method_name << '",' \
         << call_method_level << ',' \

data/lib/rotoscope/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rotoscope
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1.pre.1
 platform: ruby
 authors:
 - Jahfer Husain
@@ -115,9 +115,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6