rotoscope 0.3.1.pre.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f235b178221927dc48cb085e138c9d26981f32a2731dd98c2fb1a064f7ea23c3
-  data.tar.gz: 27b4ffd1e8f2a73fcf293ff4998cf9baf804a4a9d26c5a2e268bea08bc72fe11
+  metadata.gz: fb0b39e7f67f3038593c3dc6021e903404a75117afbe8364eb80a2941bbfa8ef
+  data.tar.gz: 7d3fceeb211a47f13088b099e26db5e5e8847b84c14090aa64d58bf6c919d92d
 SHA512:
-  metadata.gz: 2676387c826f085de81851e59cca0326a8144b2a5b341acf2cce1e6f4ec0caa3112e9b4170702ea4587f0f6ba896008b2355b184022d7e900c065eb72dc5125c
-  data.tar.gz: 7a2b9f6e7b1f568d5f003ef747233462b0ee6d58b7b5b879d3ff52e5de9a3afee64557d27ce1795c6fa0fdd0f390e23f1333c8727597a826d65927b6e2615eca
+  metadata.gz: 493b13e1a1f905be9c9c4774cd5d7280f5c163b791bfbe0d3b3dec81b0c575cc3b35063d0db62ba21ce5126810431dbf2d9197f3d224f008e9e143cfb346b81c
+  data.tar.gz: f67d35ba99ba3400714365ed02475bf5efc345bafb2f76f9834ad964fbfbc4538698deb00ea8e159320b5b788aa8d2f880f60c78fd463511e97d17cf1ba9790c

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+      time: "14:00"
+    open-pull-requests-limit: 100
+    insecure-external-code-execution: allow
+    registries: "*"
+    groups:
+      minor-gem-update:
+        update-types:
+          - "minor"
+      patch-gem-update:
+        update-types:
+          - "patch"

data/.github/workflows/ci.yml

@@ -6,21 +6,27 @@ on:
 jobs:
   test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.7"]
     steps:
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - run: bundle exec rake
 
   valgrind:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ["2.7"]
     steps:
-    - run: sudo apt-get install -y valgrind
+    - run: sudo apt-get update && sudo apt-get install -y valgrind
     - uses: actions/checkout@v2
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7
+        ruby-version: ${{ matrix.ruby }}
         bundler-cache: true
     - run: bundle exec rake test:valgrind

data/.rubocop.yml

@@ -6,9 +6,12 @@ inherit_gem:
 AllCops:
   Exclude:
     - 'tmp/**/*'
-  TargetRubyVersion: 2.7
 
-Metrics/LineLength:
+Layout/LineLength:
+  Exclude:
+    - 'test/**/*'
+
+Naming/MethodName:
   Exclude:
     - 'test/**/*'
 

data/.ruby-version

@@ -0,0 +1 @@
+2.7.8

data/Gemfile

@@ -5,4 +5,4 @@ gemspec
 
 gem "rubocop", require: false
 gem "rubocop-shopify", require: false
-gem "ruby_memcheck", "~> 0.3.0", require: false
+gem "ruby_memcheck", "~> 2.3.0", require: false

data/README.md

@@ -9,6 +9,13 @@ Rotoscope is a high-performance logger of Ruby method invocations.
 
 Rotoscope is subject to breaking changes in minor versions until `1.0` is available.
 
+## Table of Contents
+
+- [Example](https://github.com/Shopify/rotoscope?tab=readme-ov-file#example)
+- [API](https://github.com/Shopify/rotoscope?tab=readme-ov-file#api)
+  - [Default Logging Interface](https://github.com/Shopify/rotoscope?tab=readme-ov-file#default-logging-interface)
+  - [Low-level API](https://github.com/Shopify/rotoscope?tab=readme-ov-file#low-level-api)
+
 ## Example
 
 ```ruby

data/dev.yml

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

data/ext/rotoscope/rotoscope.c

@@ -124,7 +124,11 @@ static void event_hook(VALUE tpval, void *data) {
 
   config->callsite = tracearg_path(trace_arg);
 
-  config->caller = rs_stack_peek(&config->stack);
+  rs_stack_frame_t *caller = rs_stack_peek(&config->stack);
+  config->has_caller = caller != NULL;
+  if (caller != NULL) {
+    config->caller = *caller;
+  }
 
   rs_method_desc_t method_desc = called_method_desc(trace_arg);
   rs_stack_push(&config->stack, (rs_stack_frame_t){.method = method_desc});
@@ -137,6 +141,9 @@ static void rs_gc_mark(void *data) {
   rb_gc_mark(config->tracepoint);
   rb_gc_mark(config->trace_proc);
   rs_stack_mark(&config->stack);
+  if (config->has_caller) {
+    rs_method_desc_mark(&config->caller.method);
+  }
 }
 
 static void rs_dealloc(void *data) {
@@ -146,29 +153,26 @@ static void rs_dealloc(void *data) {
   xfree(config);
 }
 
-static size_t rs_memsize(const void *data) {
-  return sizeof(Rotoscope);
-}
+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
-};
+    .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 =
-      TypedData_Make_Struct(klass, Rotoscope, &rs_data_type, config);
+  VALUE self = TypedData_Make_Struct(klass, Rotoscope, &rs_data_type, config);
   config->self = self;
   config->pid = getpid();
   config->tid = current_thread_id();
   config->tracing = false;
-  config->caller = NULL;
+  config->has_caller = false;
   config->callsite = (rs_callsite_t){
       .filepath = Qnil,
       .lineno = 0,
@@ -207,6 +211,7 @@ VALUE rotoscope_stop_trace(VALUE self) {
     rb_tracepoint_disable(config->tracepoint);
     config->tracing = false;
     rs_stack_reset(&config->stack);
+    config->has_caller = false;
   }
 
   return Qnil;
@@ -259,18 +264,18 @@ VALUE rotoscope_singleton_method_p(VALUE self) {
 
 VALUE rotoscope_caller_object(VALUE self) {
   Rotoscope *config = get_config(self);
-  if (config->caller == NULL) {
+  if (!config->has_caller) {
     return Qnil;
   }
-  return config->caller->method.receiver;
+  return config->caller.method.receiver;
 }
 
 VALUE rotoscope_caller_class(VALUE self) {
   Rotoscope *config = get_config(self);
-  if (config->caller == NULL) {
+  if (!config->has_caller) {
     return Qnil;
   }
-  return rs_method_class(&config->caller->method);
+  return rs_method_class(&config->caller.method);
 }
 
 VALUE rotoscope_caller_class_name(VALUE self) {

data/ext/rotoscope/rotoscope.h

@@ -19,7 +19,9 @@ typedef struct {
   unsigned long tid;
   bool tracing;
   rs_stack_t stack;
-  rs_stack_frame_t *caller;
+  // Copy, not a pointer into `stack`: pushing may realloc the stack buffer.
+  rs_stack_frame_t caller;
+  bool has_caller;
   rs_callsite_t callsite;
   VALUE trace_proc;
 } Rotoscope;

data/ext/rotoscope/stack.c

@@ -62,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/lib/rotoscope/version.rb

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

data/rotoscope.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |s|
   end
   s.metadata["allowed_push_host"] = "https://rubygems.org/"
 
-  s.required_ruby_version = ">= 2.2.0"
+  s.required_ruby_version = ">= 2.7.0"
   s.extensions = ["ext/rotoscope/extconf.rb"]
 
   s.add_development_dependency("minitest", "~> 5.0")
-  s.add_development_dependency("mocha", "~> 0.14")
-  s.add_development_dependency("rake-compiler", "~> 0.9")
+  s.add_development_dependency("mocha", "~> 2.4")
+  s.add_development_dependency("rake-compiler", "~> 1.2")
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rotoscope
 version: !ruby/object:Gem::Version
-  version: 0.3.1.pre.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Jahfer Husain
 - Dylan Thacker-Smith
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -31,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.2'
 description: High-performance logger of Ruby method invocations
 email: jahfer.husain@shopify.com
 executables: []
@@ -62,11 +61,13 @@ extra_rdoc_files: []
 files:
 - ".clang-format"
 - ".github/PULL_REQUEST_TEMPLATE"
+- ".github/dependabot.yml"
 - ".github/workflows/ci.yml"
 - ".github/workflows/cla.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -93,7 +94,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.21
-signing_key: 
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Tracing Ruby
 test_files: []