stack_trace 0.2.1 → 0.3.0

data/lib/stack_trace/patch/false_class.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class FalseClass
+  def st_name
+    self
+  end
+end

data/lib/stack_trace/patch/nil_class.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class NilClass
+  def st_name
+    self
+  end
+end

data/lib/stack_trace/patch/numeric.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Numeric
+  def st_name
+    self
+  end
+end

data/lib/stack_trace/patch/object.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Object
+  def st_name
+    "#{self.class.name}:#{format('%#016x', (object_id << 1))}>"
+  end
+end

data/lib/stack_trace/patch/symbol.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Symbol
+  def st_name
+    "Symbol:#{to_s}"
+  end
+end

data/lib/stack_trace/patch/true_class.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class TrueClass
+  def st_name
+    self
+  end
+end

data/lib/stack_trace/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StackTrace
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/stack_trace.rb

@@ -1,48 +1,42 @@
-# frozen-string-literal: true
-
-require "stack_trace/configuration"
-require "stack_trace/module_extensions"
-require "stack_trace/setup"
-require "stack_trace/span"
-require "stack_trace/trace"
-require "stack_trace/version"
+# frozen_string_literal: true
+
+require_relative "stack_trace/version"
+require_relative "stack_trace/configuration"
+require_relative "stack_trace/argument_extractor"
+require_relative "stack_trace/patch/object"
+require_relative "stack_trace/patch/class"
+require_relative "stack_trace/patch/nil_class"
+require_relative "stack_trace/patch/numeric"
+require_relative "stack_trace/patch/false_class"
+require_relative "stack_trace/patch/true_class"
+require_relative "stack_trace/patch/symbol"
+require_relative "stack_trace/ext/stack_trace"
 
 module StackTrace
-  TRACED_EVENTS = %i(call c_call return c_return raise).freeze
-
   class << self
-    def configure
-      yield configuration
-      trace_point.enable
-    end
+    def configure(&block)
+      return false if configuration.frozen?
 
-    def configuration
-      @configuration ||= Configuration.new
+      block.call(configuration)
+
+      Sidecar.run
+      configuration.freeze
     end
 
-    def trace
-      return unless block_given?
+    def trace(&block)
+      start_trace # This creates the wrapper span
 
-      Trace.start
-      yield
-    end
+      trace_point.enable do
+        block.call
+      end
 
-    def current
-      Trace.current
+      complete_trace
     end
 
-    def as_json
-      Trace.as_json
-    end
+    private
 
-    def trace_point
-      @trace_point ||= TracePoint.new(*TRACED_EVENTS) { |tp| Trace.track(tp) }
+    def configuration
+      @configuration ||= Configuration.new
     end
   end
 end
-
-TracePoint.new(:class) do |tp|
-  tp.binding.eval <<~RUBY
-    self.stack_trace_source_location = __FILE__
-  RUBY
-end.enable

data/stack_trace.gemspec

@@ -1,32 +1,34 @@
+# frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "stack_trace/version"
+require_relative "lib/stack_trace/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "stack_trace"
-  spec.version       = StackTrace::VERSION
-  spec.authors       = ["Mehmet Emin INAC"]
-  spec.email         = ["mehmetemininac@gmail.com"]
+  spec.name = "stack_trace"
+  spec.version = StackTrace::VERSION
+  spec.authors = ["Mehmet Emin INAC"]
+  spec.email = ["mehmetemininac@gmail.com"]
 
-  spec.summary       = "Tracks the execution of methods configured"
-  spec.description   = "This library tracks the execution of methods, their arguments, return values etc."
-  spec.homepage      = "https://github.com/meinac/stack_trace"
-  spec.license       = "MIT"
+  spec.summary = "StackTrace"
+  spec.description = "StackTrace"
+  spec.homepage = "https://github.com/meinac/stack_trace"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.extensions = %w[ext/stack_trace/extconf.rb]
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.2'
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,103 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: stack_trace
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Mehmet Emin INAC
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !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: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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: This library tracks the execution of methods, their arguments, return
-  values etc.
+date: 2023-04-05 00:00:00.000000000 Z
+dependencies: []
+description: StackTrace
 email:
 - mehmetemininac@gmail.com
 executables: []
-extensions: []
+extensions:
+- ext/stack_trace/extconf.rb
 extra_rdoc_files: []
 files:
-- ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
+- ext/stack_trace/configuration.c
+- ext/stack_trace/configuration.h
+- ext/stack_trace/current_trace.c
+- ext/stack_trace/current_trace.h
+- ext/stack_trace/debug.c
+- ext/stack_trace/debug.h
+- ext/stack_trace/event_producer.c
+- ext/stack_trace/event_producer.h
+- ext/stack_trace/event_store.c
+- ext/stack_trace/event_store.h
+- ext/stack_trace/extconf.rb
+- ext/stack_trace/sidecar.c
+- ext/stack_trace/sidecar.h
+- ext/stack_trace/span.c
+- ext/stack_trace/span.h
+- ext/stack_trace/stack_trace.c
+- ext/stack_trace/trace.c
+- ext/stack_trace/trace.h
+- ext/stack_trace/types/event.h
+- ext/stack_trace/types/span.h
+- ext/stack_trace/types/trace.h
+- ext/stack_trace/utils.c
+- ext/stack_trace/utils.h
 - lib/stack_trace.rb
+- lib/stack_trace/argument_extractor.rb
 - lib/stack_trace/configuration.rb
-- lib/stack_trace/integration/rspec.rb
-- lib/stack_trace/module_extensions.rb
-- lib/stack_trace/setup.rb
-- lib/stack_trace/span.rb
-- lib/stack_trace/trace.rb
+- lib/stack_trace/patch/class.rb
+- lib/stack_trace/patch/false_class.rb
+- lib/stack_trace/patch/nil_class.rb
+- lib/stack_trace/patch/numeric.rb
+- lib/stack_trace/patch/object.rb
+- lib/stack_trace/patch/symbol.rb
+- lib/stack_trace/patch/true_class.rb
 - lib/stack_trace/version.rb
 - stack_trace.gemspec
 homepage: https://github.com/meinac/stack_trace
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,15 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
-summary: Tracks the execution of methods configured
+summary: StackTrace
 test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.2
-before_install: gem install bundler -v 2.0.1

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "stack_trace"
-
-# 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

@@ -1,8 +0,0 @@
-#!/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/stack_trace/integration/rspec.rb

@@ -1,79 +0,0 @@
-# frozen-string-literal: true
-
-require "json"
-
-RSpec.configuration.before(:suite) do
-  StackTrace::Integration::Rspec.create_tracing_directory
-end
-
-RSpec.configuration.after(:suite) do
-  StackTrace::Integration::Rspec.finish_tracing
-end
-
-RSpec.configuration.around(:each) do |example|
-  StackTrace.trace do
-    example.run
-    StackTrace::Integration::Rspec.save_trace_for(example)
-  end
-end
-
-module StackTrace
-  module Integration
-    class Rspec
-      EXAMPLE_META_KEYS = %i(file_path line_number scoped_id description full_description)
-      FINAL_MESSAGE = <<~TEXT
-        \e[1m
-        StackTrace:
-
-        Trace information is saved into \e[32m%{file_path}\e[0m
-        \e[22m
-      TEXT
-
-      class << self
-        def create_tracing_directory
-          Dir.mkdir(tracing_dir_path) unless Dir.exist?(tracing_dir_path)
-        end
-
-        def finish_tracing
-          save_examples
-          print_message
-        end
-
-        def save_trace_for(example)
-          examples << example_data(example)
-        end
-
-        private
-
-        def examples
-          @examples ||= []
-        end
-
-        def save_examples
-          File.write(tracing_file_path, examples.to_json)
-        end
-
-        def tracing_file_path
-          File.join(tracing_dir_path, trace_file_name)
-        end
-
-        def tracing_dir_path
-          File.expand_path("stack_trace")
-        end
-
-        def trace_file_name
-          @trace_file_name ||= Time.now.strftime('%d_%m_%Y %H_%M_%S.json')
-        end
-
-        def example_data(example)
-          example.metadata.slice(*EXAMPLE_META_KEYS)
-                          .merge!(trace: Trace.current.as_json)
-        end
-
-        def print_message
-          puts format(FINAL_MESSAGE, file_path: tracing_file_path)
-        end
-      end
-    end
-  end
-end

data/lib/stack_trace/module_extensions.rb

@@ -1,13 +0,0 @@
-# frozen-string-literal: true
-
-module StackTrace
-  module ModuleExtensions
-    attr_accessor :stack_trace_source_location
-
-    def trace_method?(method_id)
-      Setup.trackable?(self, method_id)
-    end
-  end
-end
-
-Module.include(StackTrace::ModuleExtensions)

data/lib/stack_trace/setup.rb

@@ -1,62 +0,0 @@
-# frozen-string-literal: true
-
-module StackTrace
-  class Setup
-    class << self
-      def trackable?(mod, method_id)
-        store[mod].trace?(method_id)
-      end
-
-      def store
-        @store ||= Hash.new do |h, k|
-          h[k.singleton_class] = new(k, :class_methods)
-          h[k] = new(k, :instance_methods)
-        end
-      end
-    end
-
-    def initialize(klass, context)
-      self.klass = klass
-      self.context = context
-    end
-
-    def trace?(method_id)
-      enabled? && traced_method?(method_id)
-    end
-
-    private
-
-    attr_accessor :klass, :context
-
-    def enabled?
-      defined?(@enabled) ? @enabled : (@enabled = !config.nil?)
-    end
-
-    def config
-      @config ||= StackTrace.configuration.for(klass)
-    end
-
-    def traced_method?(method_id)
-      method_lookup[method_id]
-    end
-
-    def method_lookup
-      @method_lookup ||= Hash.new { |lookup, method_id| lookup[method_id] = method_enabled?(method_id) }
-    end
-
-    def method_enabled?(method_id)
-      case method_config
-      when Array
-        method_config.include?(method_id)
-      when Symbol
-        method_config != :skip_inherited || instance_methods(false).include?(method_id)
-      when Regexp
-        method_id =~ method_config
-      end
-    end
-
-    def method_config
-      @method_config ||= config[1].fetch(context, [])
-    end
-  end
-end

data/lib/stack_trace/span.rb

@@ -1,94 +0,0 @@
-# frozen-string-literal: true
-
-module StackTrace
-  class Span
-    class << self
-      def start_from(trace_point, parent)
-        new(
-          receiver(trace_point),
-          trace_point.method_id,
-          extract_arguments(trace_point),
-          parent
-        )
-      end
-
-      private
-
-      def receiver(trace_point)
-        trace_point.binding.eval("self").to_s
-      end
-
-      def extract_arguments(trace_point)
-        trace_point.parameters
-                   .map(&:last)
-                   .each_with_object({}) do |parameter, memo|
-                      memo[parameter] = trace_point.binding.eval(parameter.to_s).inspect
-                   end
-      end
-    end
-
-    attr_writer :exception
-
-    def initialize(receiver, method_name, args, parent)
-      self.receiver = receiver
-      self.method_name = method_name
-      self.args = args
-      self.parent = parent
-      self.started_at = Time.now.to_f
-      self.spans = []
-    end
-
-    def <<(span)
-      (spans << span) && span
-    end
-
-    def close(trace_point)
-      self.value = trace_point.return_value.inspect
-      self.finished_at = Time.now.to_f
-      parent
-    end
-
-    def as_json
-      {
-        receiver: receiver,
-        method_name: method_name,
-        arguments: args,
-        value: value,
-        exception: exception_as_json,
-        time: time,
-        spans: spans.map(&:as_json)
-      }
-    end
-
-    private
-
-    attr_accessor :receiver, :method_name, :args, :value, :parent, :spans, :started_at, :finished_at
-    attr_reader :exception
-
-    def time
-      case time_ns
-      when 0..1_000
-        "#{time_ns} ns"
-      when 0..1_000_000
-        "#{time_ns / 1_000} µs"
-      when 0..1_000_000_000
-        "#{time_ns / 1_000_000} ms"
-      else
-        "#{time_ns / 1_000_000_000} s"
-      end
-    end
-
-    def exception_as_json
-      return unless exception
-
-      {
-        message: exception.message,
-        backtrace: exception.backtrace
-      }
-    end
-
-    def time_ns
-      (finished_at - started_at) * 1_000_000_000
-    end
-  end
-end