tracia 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 363d76e2a793f137185051d30570d69c98051ddd1f1f10769eba90a2bcb28167
-  data.tar.gz: 1268959b896e1b410ac7e9d0d0d46fd1c4e60d27ccf45655581e05288a9ba62c
+  metadata.gz: 3cb9b65fa0d3c36e530bdf201281a35c6f58d38273e2287b12d80688b2cc0a8a
+  data.tar.gz: b61d048ac0eb2f09cc432e2ca4aaa0035e4a1ab2d7e6d18b848cdce1d97b67a4
 SHA512:
-  metadata.gz: fb07182692dca1890de5248ecd55f904f9ca81512eee9f1f7d3a392c0d6d52c6727794b5963f4d6abda458bbcfb7c4c46a62c03db073dfaa18dcf8329168bd91
-  data.tar.gz: 0540c570c7184eecff45c83ae58951250c6c31cfcfd3b1e304ee83b70a66b9ae2d72d14180c6f1f642a4f751ab8dd6c9ea2fd6fc2ac4ca5eebe3d381422e8447
+  metadata.gz: 5432ae3e05b76ca7fe8c90ef02843669e627e6aae92e42c257285f37cdcaa03215badbf9b2ad86cac9dc0462cef6a8e60190434de79612028fade99edb6c894b
+  data.tar.gz: c41e5de84fc6aba18dcecbadd856c4715f2ffd8ffdcfbc1cc93ffcd35956003f0d4948e313eb93621101395f50e54b26c7ebf41c394bf632a47ba63d77922491

data/README.md

@@ -1,8 +1,6 @@
 # Tracia
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tracia`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Construct call stack in tree-style
 
 ## Installation
 
@@ -22,7 +20,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Put `Tracia.add` in method call
+
+```ruby
+def do_something
+  do_somthing_deep
+end
+
+def do_something_deep
+  Tracia.add("I am working on something deep")
+end
+```
+
+Wrap the call with `Tracia.start`
+
+```ruby
+Tracia.start do
+  do_something()
+end
+```
+
+### Custom Logger
+
+By default, Tracia writes result to STDOUT, you can set it somewhere else
+
+```ruby
+file = File.new('/path/to/log.txt', 'w+')
+
+Tracia.start(logger: Tracia::DefaultLogger.new(out: file)) do
+  # ...
+end
+```
+
+Or you can make a logger class which responds to `call`
+
+```ruby
+class MyLogger
+  def initialize(database)
+    @database = database
+  end
+
+  # callback method for Tracia
+  def call(root)
+    # ...
+    @database.insert(root)
+  end
+end
+```
+
+Then pass that logger to Tracia
+
+```ruby
+Tracia.start(logger: MyLogger.new(db_connection)) do
+  # ..
+end
+```
 
 ## Development
 

data/lib/tracia/default_logger.rb

@@ -0,0 +1,25 @@
+class Tracia
+  class DefaultLogger
+    NO_CHILD = []
+
+    class << self
+      def tree_graph_everything!
+        Object.define_method(:label_for_tree_graph) do
+          to_s
+        end
+
+        Object.define_method(:children_for_tree_graph) do
+          NO_CHILD
+        end
+      end
+    end
+
+    def initialize(out: STDOUT)
+      @out = out
+    end
+
+    def call(root)
+      @out.puts root.tree_graph
+    end
+  end
+end

data/lib/tracia/frame.rb

@@ -0,0 +1,32 @@
+require "tree_graph"
+
+class Tracia
+  class Frame
+    include TreeGraph
+
+    attr_reader :klass, :call_sym, :method_name, :children, :file
+
+    def initialize(klass, call_sym, method_name, file, lineno)
+      @klass = klass
+      @call_sym = call_sym
+      @method_name = method_name
+      @file = file
+      @lineno = lineno
+      @children = []
+    end
+
+    def same_klass_and_method?(other_frame)
+      klass == other_frame.klass &&
+        call_sym == other_frame.call_sym &&
+        method_name == other_frame.method_name
+    end
+
+    def label_for_tree_graph
+      "#{klass}#{call_sym}#{method_name} #{GemPaths.shorten(@file)}:#{@lineno}"
+    end
+
+    def children_for_tree_graph
+      children
+    end
+  end
+end

data/lib/tracia/gem_paths.rb

@@ -0,0 +1,19 @@
+require "yaml"
+
+class Tracia
+  module GemPaths
+    ABSTRACTS = {}
+
+    ::YAML.load(`gem env`.gsub(/=>/, ':'))['RubyGems Environment']
+      .detect{ |hash| hash.has_key?('GEM PATHS') }['GEM PATHS']
+      .each_with_index { |path, i| ABSTRACTS["GemPath#{i}"] = path }
+
+    class << self
+      def shorten(location)
+        return '' if location.nil?
+        ABSTRACTS.each{ |name, path| location = location.gsub(path, "$#{name}") }
+        location
+      end
+    end
+  end
+end

data/lib/tracia/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Tracia
-  VERSION = "0.1.0"
+  VERSION = "0.2.2"
 end

data/lib/tracia.rb

@@ -1,75 +1,164 @@
 # frozen_string_literal: true
 
-require_relative "tracia/version"
+require "tracia/version"
+require "tracia/gem_paths"
+require "tracia/frame"
+require "tracia/default_logger"
+
+require "binding_of_callers"
 
 class Tracia
   class Error < StandardError; end
 
-  attr_accessor :level, :error
+  INSTANCE_METHOD_SHARP = '#'
+
+  attr_accessor :level, :error, :depth
 
-  # Your code goes here...
   class << self
-    def start
-      trc = (Thread.current[:_tracia_] ||= new)
+    def start(**opt)
+      trc = (Thread.current[:_tracia_] ||= new(**opt))
       trc.level += 1
+      trc.depth = binding.frame_count + 1
       yield
     rescue StandardError => e
       trc.error = e
       raise e
     ensure
       trc.level -= 1
-      Thread.current[:_tracia_] = nil if trc.error || trc.level == 0
-      trc.log if trc.level == 0 && trc.error.nil?
+      if trc.error || trc.level == 0
+        Thread.current[:_tracia_] = nil
+        trc.disable_trace_point
+      end
+      trc.log if trc.level == 0
     end
 
-    def add(attrs)
+    def add(info)
       trc = Thread.current[:_tracia_]
-      trc.add(caller, attrs) if trc
+      return unless trc
+
+      backtrace = binding.partial_callers(-trc.depth)
+      backtrace.reverse!
+      backtrace.pop
+      trc.add(backtrace, info)
     end
   end
 
-  class Frame
-    attr_reader :name, :children
+  def initialize(**opt)
+    @frames_to_reject = Array(opt[:reject])
+    @non_tail_recursion = opt[:non_tail_recursion]
+    @logger = opt[:logger] || DefaultLogger.new
 
-    def initialize(name, level)
-      @name = name
-      @level = level
-      @children = []
-      @data = []
-    end
+    @backtraces = []
+    @level = 0
+
+    enable_trace_point
+  end
 
-    def inspect
-      spaces = ' ' * @level
-      @children.empty? ? "#{@name}\n" : "#{@name} ->\n#{spaces}#{@children}"
+  def enable_trace_point
+    current_thread = Thread.current
+    @trace_point = TracePoint.new(:raise) do |point|
+      bd = point.binding
+      next unless current_thread == bd.eval('Thread.current')
+      backtrace = bd.eval("binding.partial_callers(-#{depth})")
+      raiser = backtrace[0]
+      next if raiser.klass == Tracia && raiser.frame_env == 'rescue in start'
+      backtrace.reverse!
+      backtrace.pop
+      backtrace.pop
+      add(backtrace, point.raised_exception)
     end
+    @trace_point.enable
   end
 
-  def initialize
-    @stacks = []
-    @level = 0
+  def disable_trace_point
+    @trace_point.disable
   end
 
-  def add(stack, data)
-    @stacks << [stack, data]
+  def add(backtrace, info)
+    backtrace = convert_to_frames(backtrace)
+    @backtraces << [backtrace, info]
   end
 
   def log
-    frames = []
-    @stacks.each do |stack, data|
-      stack.reverse.each_with_index do |raw_frame, idx|
-        frame = frames[idx]
-        if frame == nil
-          frame = Frame.new(raw_frame, idx)
-          frames[idx - 1].children << frame if idx > 0
-          frames[idx] = frame
-        elsif frame.name != raw_frame
-          frame = Frame.new(raw_frame, idx)
-          frames[idx - 1].children << frame if idx > 0
-          frames[idx] = frame
-          frames = frames.slice(0, idx + 1)
-        end
+    @stack = []
+
+    @backtraces.each do |backtrace, info|
+      build_road_from_root_to_leaf(backtrace)
+      @stack.last.children << info
+    end
+
+    root = @stack[0]
+    if root
+      non_tail_recursion!([root]) if @non_tail_recursion
+      @logger.call(root)
+    end
+  end
+
+  private
+
+  def non_tail_recursion!(stack)
+    current_frame = stack.last
+    last_idx = current_frame.children.count - 1
+
+    current_frame.children.each_with_index do |child, idx|
+      next unless Frame === child
+      next non_tail_recursion!([child]) if last_idx != idx
+
+      recursion_idx = stack.index{ |frame| frame.same_klass_and_method?(child) }
+      if recursion_idx
+        parent = stack[recursion_idx - 1]
+        parent.children << child
+        current_frame.children.pop
+        non_tail_recursion!([parent, child])
+      else
+        stack.push(child)
+        non_tail_recursion!(stack)
+      end
+    end
+  end
+
+  def build_road_from_root_to_leaf(backtrace)
+    backtrace.reject!{ |raw_frame| reject?(raw_frame) }
+    backtrace.each_with_index do |raw_frame, idx|
+      frame = @stack[idx]
+      if frame == nil
+        push_frame(raw_frame, idx)
+      elsif !frame.same_klass_and_method?(raw_frame)
+        @stack = @stack.slice(0, idx + 1)
+        push_frame(raw_frame, idx)
       end
     end
-    p frames
+
+    @stack = @stack.slice(0, backtrace.size) if @stack.size > backtrace.size
+  end
+
+  def push_frame(frame, idx)
+    @stack[idx - 1].children << frame if idx > 0
+    @stack[idx] = frame
+  end
+
+  def reject?(raw_frame)
+    @frames_to_reject.any?{ |rj| rj =~ raw_frame.file }
+  end
+
+  def convert_to_frames(callers)
+    callers.map! do |c|
+      _binding = c._binding
+      klass = c.klass
+      call_symbol = c.call_symbol
+      frame_env = c.frame_env
+
+      source_location =
+        if _binding.frame_type == :method
+          meth = call_symbol == INSTANCE_METHOD_SHARP ? klass.instance_method(frame_env) : klass.method(frame_env)
+          meth.source_location
+        else
+          _binding.source_location
+        end
+
+      Frame.new(klass, call_symbol, frame_env, source_location[0], source_location[1])
+    end
+
+    callers
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tracia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - ken
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tree_graph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: binding_of_callers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 description: 
 email:
 - block24block@gmail.com
@@ -37,6 +65,9 @@ files:
 - README.md
 - Rakefile
 - lib/tracia.rb
+- lib/tracia/default_logger.rb
+- lib/tracia/frame.rb
+- lib/tracia/gem_paths.rb
 - lib/tracia/version.rb
 - sig/tracia.rbs
 homepage: https://github.com/turnon/tracia